"; text = addDiffs(oldDocWords, newDocWords, script, text); text += ""; docDiffs.add(new DiffOutput(pkgName, className, id, title, text)); } /** * Convert the string to an array of strings, but don't break HTML tags up. */ static String[] parseDoc(String doc) { String delimiters = " .,;:?!(){}[]\"'~@#$%^&*+=_-|\\<>/"; StringTokenizer st = new StringTokenizer(doc, delimiters, true); List docList = new ArrayList(); boolean inTag = false; String tag = null; while (st.hasMoreTokens()) { String tok = st.nextToken(); if (!inTag) { if (tok.compareTo("<") == 0) { tag = tok; if (st.hasMoreTokens()) { // See if this really is a tag tok = st.nextToken(); char ch = tok.charAt(0); if (Character.isLetter(ch) || ch == '/') { inTag = true; tag += tok; } } if (!inTag) docList.add(tag); } else { docList.add(tok); } } else { // Add all tokens to the tag until the closing > is seen if (tok.compareTo(">") == 0) { inTag = false; tag += tok; docList.add(tag); } else { tag += tok; } } } if (inTag) { // An unterminated tag, or more likely, < used instead of < // There are no nested tags such as > in HTML docList.add(tag); } String[] docWords = new String[docList.size()]; docWords = (String[])docList.toArray(docWords); return docWords; } /** * For improved readability, merge changes of the form * "delete 1, insert 1, space, delete 1, insert 1" * to * "delete 3, insert 3" (including the space). * * @param oldDocWords The original documentation as a String array * @param newDocWords The new documentation as a String array */ static DiffMyers.change mergeDiffs(String[] oldDocWords, String[] newDocWords, DiffMyers.change script) { if (script.link == null) return script; // Only one change DiffMyers.change hunk = script; DiffMyers.change lasthunk = null; // Set to the last potential hunk int startOld = 0; for (; hunk != null; hunk = hunk.link) { int deletes = hunk.deleted; int inserts = hunk.inserted; if (lasthunk == null) { if (deletes == 1 && inserts == 1) { // This is the start of a potential merge lasthunk = hunk; } continue; } else { int first0 = hunk.line0; // Index of first deleted word int first1 = hunk.line1; // Index of first inserted word if (deletes == 1 && inserts == 1 && oldDocWords[first0 - 1].compareTo(" ") == 0 && newDocWords[first1 - 1].compareTo(" ") == 0 && first0 == lasthunk.line0 + lasthunk.deleted + 1 && first1 == lasthunk.line1 + lasthunk.inserted + 1) { // Merge this change into the last change lasthunk.deleted += 2; lasthunk.inserted += 2; lasthunk.link = hunk.link; } else { lasthunk = null; } } } return script; } /** * Add the differences to the text passed in. The old documentation is * edited using the edit script provided by the DiffMyers object. * Do not display diffs in HTML tags. * * @param oldDocWords The original documentation as a String array * @param newDocWords The new documentation as a String array * @return The text for this documentation difference */ static String addDiffs(String[] oldDocWords, String[] newDocWords, DiffMyers.change script, String text) { String res = text; DiffMyers.change hunk = script; int startOld = 0; if (trace) { System.out.println("Old Text:"); for (int i = 0; i < oldDocWords.length; i++) { System.out.print(oldDocWords[i]); } System.out.println(":END"); System.out.println("New Text:"); for (int i = 0; i < newDocWords.length; i++) { System.out.print(newDocWords[i]); } System.out.println(":END"); } for (; hunk != null; hunk = hunk.link) { int deletes = hunk.deleted; int inserts = hunk.inserted; if (deletes == 0 && inserts == 0) { continue; // Not clear how this would occur, but handle it } // Determine the range of word and delimiter numbers involved // in each file. int first0 = hunk.line0; // Index of first deleted word // Index of last deleted word, invalid if deletes == 0 int last0 = hunk.line0 + hunk.deleted - 1; int first1 = hunk.line1; // Index of first inserted word // Index of last inserted word, invalid if inserts == 0 int last1 = hunk.line1 + hunk.inserted - 1; if (trace) { System.out.println("HUNK: "); System.out.println("inserts: " + inserts); System.out.println("deletes: " + deletes); System.out.println("first0: " + first0); System.out.println("last0: " + last0); System.out.println("first1: " + first1); System.out.println("last1: " + last1); } // Emit the original document up to this change for (int i = startOld; i < first0; i++) { res += oldDocWords[i]; } // Record where to start the next hunk from startOld = last0 + 1; // Emit the deleted words, but struck through // but do not emit deleted HTML tags if (deletes != 0) { boolean inStrike = false; for (int i = first0; i <= last0; i++) { if (!oldDocWords[i].startsWith("<") && !oldDocWords[i].endsWith(">")) { if (!inStrike) { if (deleteEffect == 0) res += "
");
diffFile.println("
| ");
// The right hand side title
diffFile.println("Generated by JDiff | ");
diffFile.println("||||||||
| "); if (prevPkgName != null) diffFile.println(" PREV PACKAGE "); else diffFile.println(" PREV PACKAGE "); if (nextPkgName != null) diffFile.println(" NEXT PACKAGE"); else diffFile.println(" NEXT PACKAGE"); diffFile.println(" "); diffFile.println(" FRAMES "); diffFile.println(" NO FRAMES | "); diffFile.println(""); diffFile.println(" | ||||||||
"); diffFile.println("This file contains all the changes in documentation in the package"); diffFile.println("" + currPkgName + "as colored differences."); if (deleteEffect == 0) diffFile.println("Deletions are shownlike this, and"); else if (deleteEffect == 1) diffFile.println("Deletions are shown like this, and"); if (insertEffect == 0) diffFile.println("additions are shown in red like this."); else if (insertEffect == 1) diffFile.println("additions are shown like this."); diffFile.println("
"); diffFile.println("If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. "); diffFile.println("If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. "); diffFile.println("Similarly, documentation which was inherited from another class or interface is not shown here."); diffFile.println(""); diffFile.println("
"); diffFile.println(" Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently."); diffFile.println(""); diffFile.println("
");
diffFile.println("
| ");
// The right hand side title
diffFile.println("Generated by JDiff | ");
diffFile.println("||||||||
| "); diffFile.println(" FRAMES "); diffFile.println(" NO FRAMES | "); diffFile.println(""); diffFile.println(" | ||||||||