[JGIT PATCH v4 08/24] Added a Rules interface implementation and a factory for it.
Signed-off-by: Florian Koeberle <florianskarten@web.de>
---
.../treewalk/rules/RuleListToObjectConverter.java | 151 ++++++++++++++++++++
.../jgit/treewalk/rules/RulesImplementation.java | 88 ++++++++++++
2 files changed, 239 insertions(+), 0 deletions(-)
create mode 100644 org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RuleListToObjectConverter.java
create mode 100644 org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RulesImplementation.java
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RuleListToObjectConverter.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RuleListToObjectConverter.java
new file mode 100644
index 0000000..96f27bb
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RuleListToObjectConverter.java
@@ -0,0 +1,151 @@
+/*
+ * Copyright (C) 2008, Florian Köberle <florianskarten@web.de>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution.
+ *
+ * - Neither the name of the Git Development Community nor the
+ * names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior
+ * written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.spearce.jgit.treewalk.rules;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+/**
+ * This class converts a list of {@link Rule} objects into a {@Rules} object.
+ * During the conversion some optimizations are done:
+ * <ul>
+ * <li>Rules which can never match are removed. e.g. There is no need to check
+ * the rule "/a" in the directory b.</li>
+ * <li>The list is cut at the first rule which match always. *.txt\n/a for
+ * example would result in an internal list "ignore all, ignore *.txt" which is
+ * then reduced to "ignore all".</li>
+ * <li>Ignore rules which are direcly before an "ignore all" all rule are
+ * removed. /a\n*.txt for example would result in an intern "ignore *.txt,
+ * ignore all" list which is then reduced to "ignore all",</li>
+ * <li>"do not ignore" rules at the bottom of the intern list are removed. This
+ * optimization would remove !a from "!a\n/b" as it is in the inversed list at
+ * the bottom.</li>
+ * </ul>
+ */
+class RuleListToObjectConverter {
+ protected Rules createIgnoreRules(Iterator<Rule> ruleIterator) {
+ final List<Rule> rules = getNessesaryRulesFromIterator(ruleIterator);
+ removeUnnecessaryDoNotIgnoreRulesAtTheEndOfTheList(rules);
+ removeUnnecessaryIgnoreRulesNearTheEndOfTheList(rules);
+
+ if (rules.size() == 1) {
+ final Rule rule = rules.get(0);
+ if (rule.getPattern() == FilePattern.MATCH_ALWAYS) {
+ if (rule.isIgnoreAtMatch()) {
+ return Rules.IGNORE_ALL;
+ } else {
+ return Rules.IGNORE_NOTHING;
+ }
+ }
+ } else if (rules.isEmpty()) {
+ return Rules.IGNORE_NOTHING;
+ }
+ return new RulesImplementation(rules, this);
+ }
+
+ private List<Rule> getNessesaryRulesFromIterator(Iterator<Rule> ruleIterator) {
+ final List<Rule> rules = new ArrayList<Rule>();
+ while (ruleIterator.hasNext()) {
+ final Rule subRule = ruleIterator.next();
+ if (subRule.getPattern() == FilePattern.MATCH_NEVER) {
+ continue;
+ }
+ rules.add(subRule);
+ // There is no need for rules after a rule witch match always,
+ // as such a rule would never be the first rule which matches.
+ if (subRule.getPattern() == FilePattern.MATCH_ALWAYS) {
+ break;
+ }
+ }
+ return rules;
+ }
+
+ /**
+ * Expects that
+ * {@link #removeUnnecessaryDoNotIgnoreRulesAtTheEndOfTheList(List)} has
+ * been executed first.
+ *
+ * @param rules
+ * rule list to reduce.
+ */
+ private void removeUnnecessaryIgnoreRulesNearTheEndOfTheList(
+ final List<Rule> rules) {
+ // Why the following optimization makes only sense for the end of the
+ // list:
+ // If there is a "ignore all"- rule,
+ // then it is located at the end of the list
+ // See how the list is filled to prove this statement.
+ if (rules.size() >= 2) {
+ final Rule lastRule = rules.get(rules.size() - 1);
+ assert lastRule.isIgnoreAtMatch() : "Expected that no 'not ignore'-rule is at the end of the list any more";
+ final boolean ignoreAllAtEnd = lastRule.getPattern().equals(
+ FilePattern.MATCH_ALWAYS);
+ if (ignoreAllAtEnd) {
+ while (rules.size() >= 2) {
+ final int ruleBeforeLastIndex = rules.size() - 2;
+ final Rule ruleBeforeLast = rules.get(ruleBeforeLastIndex);
+ if (ruleBeforeLast.isIgnoreAtMatch()) {
+ rules.remove(ruleBeforeLastIndex);
+ } else {
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ private void removeUnnecessaryDoNotIgnoreRulesAtTheEndOfTheList(
+ final List<Rule> rules) {
+ // Why it is save to remove "don't ignore rules" at the end of the list
+ // if there is no "ignore rule" below a "don't ignore rule" then
+ // the path which haven't match jet will never be ignored:
+ // -> if another "don't ignore rule" match then the patch will not be
+ // ignored
+ // -> if no "don't ignore rule" match then the path will not be ignored.
+ while (!rules.isEmpty()) {
+ final int indexOfLastRule = rules.size() - 1;
+ final Rule lastRule = rules.get(indexOfLastRule);
+ if (lastRule.isIgnoreAtMatch()) {
+ break;
+ } else {
+ rules.remove(indexOfLastRule);
+ }
+ }
+ }
+}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RulesImplementation.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RulesImplementation.java
new file mode 100644
index 0000000..cd12701
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/RulesImplementation.java
@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) 2008, Florian Köberle <florianskarten@web.de>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution.
+ *
+ * - Neither the name of the Git Development Community nor the
+ * names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior
+ * written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.spearce.jgit.treewalk.rules;
+
+import java.util.Iterator;
+import java.util.List;
+
+class RulesImplementation implements Rules {
+ /**
+ * Complete list of rules. Note that order is: determining rule first.
+ */
+ private final List<Rule> rules;
+
+ /**
+ * Factory used to create {@link Rules} for sub directories.
+ */
+ private RuleListToObjectConverter factory;
+
+ RulesImplementation(List<Rule> rules, RuleListToObjectConverter factory) {
+ this.rules = rules;
+ this.factory = factory;
+ }
+
+ public boolean shouldIgnore(String fileName, boolean fileIsDirectory) {
+ for (Rule rule : rules) {
+ if (rule.getPattern().match(fileName, fileIsDirectory)) {
+ return rule.isIgnoreAtMatch();
+ }
+ }
+ return false;
+ }
+
+ public Rules getRulesForSubDirectory(final String directoryName) {
+ final Iterator<Rule> subRuleIterator = new Iterator<Rule>() {
+ final Iterator<Rule> ruleIterator = rules.iterator();
+
+ public boolean hasNext() {
+ return ruleIterator.hasNext();
+ }
+
+ public Rule next() {
+ return ruleIterator.next()
+ .getRuleForSubDirectory(directoryName);
+ }
+
+ public void remove() {
+ throw new UnsupportedOperationException();
+ }
+
+ };
+ return factory.createIgnoreRules(subRuleIterator);
+ }
+}
--
1.5.4.3