Ticket #1278: 02-positioning.patch

chrome/content/zotero/xpcom/integration.js

@@ -678 +678 @@
                                 session.addCitation(vars[i], vars[i+1]);
                         }
                 }
-                
+
                 session.updateItemSet();
                 
                 if(editCitationIndex) { 
@@ -727 +727 @@
                 
                 return output;
         }
-        
+
         /*
          * restores a session, given all citations
          * ACCEPTS: version, documentData, styleID, use-endnotes, use-bookmarks(, fieldIndex, fieldName)+
@@ -827 +827 @@
                 if(versionParts.length != 3 || versionParts[1] != COMPAT_API_VERSION) return false;
                 return true;
         }
+
 }
 
 /*
@@ -871 +872 @@
 Zotero.Integration.Session.prototype.resetRequest = function() {
         this.citationsByItemID = new Object();
         this.citationsByIndex = new Array();
+        this.firstRef = new Object();
+        this.lastRef = new Object();
         
         this.haveMissing = false;
         this.regenerateAll = false;
@@ -930 +933 @@
  * gets a Zotero.CSL.Citation object given a field name
  */
 Zotero.Integration.Session.prototype.addCitation = function(index, arg) {
+
         var index = parseInt(index, 10);
         
         if(typeof(arg) == "string") {   // text field
@@ -964 +968 @@
                 this.updateIndices[index] = true;
                 this.haveMissing = true;
         }
-        
+
         citation.properties.index = index;
         this.citationsByIndex[index] = citation;
 }
@@ -1197 +1201 @@
  * sets position attribute on a citation
  */
 Zotero.Integration.Session.prototype.getCitationPositions = function(citation, update) {
-        for(var previousIndex = citation.properties.index-1;
-                previousIndex != -1
-                        && (!this.citationsByIndex[previousIndex]
-                        || this.citationsByIndex[previousIndex].properties["delete"]); 
+        for(var previousIndex = citation.properties.index-1; 
+        previousIndex != -1
+            && (!this.citationsByIndex[previousIndex]
+                || this.citationsByIndex[previousIndex].properties["delete"]); 
                 previousIndex--) {}
-        var previousCitation = (previousIndex == -1 ? false : this.citationsByIndex[previousIndex]);
+    var previousCitation = (previousIndex == -1 ? false : this.citationsByIndex[previousIndex]);
+    // if one source is the same as the last, use ibid
+    //
+    // Case 1: source in previous citation
+    // (1) Threshold conditions
+    //     (a) there must be a previous citation with one item
+    //     (b) this item must be the first in this citation
+    //     (c) the previous citation must contain a reference to the same item ...
+    // Case 2: immediately preceding source in this citation
+    // (1) Threshold conditions
+    //     (a) there must be an imediately preceding reference to  the
+    //         same item in this citation
+    // Evaluation
+    //     (a) if the previous citation had no locator and this citation
+    //         has one, use ibid+pages
+    //     (b) if the previous citation had no locator and this citation
+    //         also has none, use ibid
+    //     (c) if the previous citation had a locator (page number, etc.) 
+    //         and this citation has a locator that is identical, use ibid
+    //     (d) if the previous citation had a locator, and this citation
+    //         has one that differs, use ibid+pages
+    //     (e) if the previous citation had a locator and this citation
+    //         has none, use subsequent
+    //     (f) if the current and previous citations are not the same,
+    //         set as FIRST or SUBSEQUENT, as appropriate.
+    //
+    // For Case 1
+    var curr = citation.citationItems[0];
+        curr.thisRef = citation.properties.index+1;
+    if(         
+       previousCitation 
+       && previousCitation.citationItems.length == 1
+       && citation.citationItems[0].itemID == previousCitation.citationItems[0].itemID ) {
+                var prev = previousCitation.citationItems[0];
+                var newPosition = this.checkIbidOrSubsequent(prev, curr, citation);
+    } else {
+                // check outside this note if necessary
+                var newPosition = this.checkFirstOrSubsequent(curr, citation );
+    }
+    this.updateCitePosition (curr, newPosition, citation, update);
+    citation.citationItems[0].position = newPosition;
+    this.checkCiteContext (citation.citationItems[0], newPosition);
+    //
+    // For Case 2
+        // step through remaining cites in this citation
+           for ( i = 1; i < citation.citationItems.length; i++) {
+                ////////////////////positionIndex++;
+                // step through possible preceding cites within same note, from back to front
+                var curr = citation.citationItems[i];
+                curr.thisRef = citation.properties.index+1;
+                var newPosition = undefined;
+                var prev = citation.citationItems[i-1];
+                if ( curr.itemID == prev.itemID ) {
+                        // check immediately preceding cite in this note
+                        newPosition = this.checkIbidOrSubsequent(prev, curr, citation);
+                } else {
+                        // check other preceding cites
+                        newPosition = this.checkFirstOrSubsequent(curr, citation );
+                }
+                this.updateCitePosition (curr, newPosition, citation, true);
+                citation.citationItems[i].position = newPosition;
+                this.checkCiteContext (citation.citationItems[i], newPosition);
+        }
+}
+
+/*
+ * evaluates position of qualifying cites
+ */
+
+Zotero.Integration.Session.prototype.checkIbidOrSubsequent = function(prev, curr, citation) {
+    var newPosition;
         
-        // if only one source, and it's the same as the last, use ibid
-        if(             // there must be a previous citation with one item, and this citation
-                        // may only have one item
-                        previousCitation && citation.citationItems.length == 1
-                        && previousCitation.citationItems.length == 1
-                        // the previous citation must have been a citation of the same item
-                        && citation.citationItems[0].item == previousCitation.citationItems[0].item
-                        // and if the previous citation had a locator (page number, etc.) 
-                        // then this citation must have a locator, or else we should do the 
-                        // full citation (see Chicago Manual of Style)
-                        && (!previousCitation.citationItems[0].locator || citation.citationItems[0].locator)) {
-                // use ibid, but check whether to use ibid+pages
-                var newPosition = (citation.citationItems[0].locator == previousCitation.citationItems[0].locator
-                        && citation.citationItems[0].locatorType == previousCitation.citationItems[0].locatorType
-                        ? Zotero.CSL.POSITION_IBID : Zotero.CSL.POSITION_IBID_WITH_LOCATOR);
-                // update if desired
-                if(update && (citation.citationItems[0].position || newPosition) && citation.citationItems[0].position != newPosition) {
-                        this.updateIndices[citation.properties.index] = true;
+        curr.distanceToLastRef = citation.properties.index+1 - this.lastRef[curr.itemID];
+        curr.firstRef = this.firstRef[curr.itemID];
+        this.lastRef[curr.itemID] = citation.properties.index+1;
+    if (!prev.locator) {
+                if (curr.locator) {
+                        newPosition = Zotero.CSL.POSITION_IBID_WITH_LOCATOR;
+                } else {
+                        newPosition = Zotero.CSL.POSITION_IBID;
                 }
-                citation.citationItems[0].position = newPosition;
-        } else {
-                // loop through to see which are first citations
-                for(var i=0; i<citation.citationItems.length; i++) {
-                        var citationItem = citation.citationItems[i];
-                        var newPosition = (!this.citationsByItemID[citationItem.itemID]
-                                        || this.citationsByItemID[citationItem.itemID][0].properties.index >= citation.properties.index
-                                ? Zotero.CSL.POSITION_FIRST : Zotero.CSL.POSITION_SUBSEQUENT);
-                        
-                        // update if desired
-                        if(update && (citation.citationItems[i].position || newPosition) && citation.citationItems[i].position != newPosition) {
-                                this.updateIndices[citation.properties.index] = true;
-                        }
-                        citation.citationItems[i].position = newPosition;
+    } else {
+                if (prev.locator == curr.locator) {
+                        newPosition = Zotero.CSL.POSITION_IBID;
+                } else if (curr.locator) {
+                        newPosition = Zotero.CSL.POSITION_IBID_WITH_LOCATOR;
+                } else {
+                        newPosition = Zotero.CSL.POSITION_SUBSEQUENT;
                 }
-        }
+    }
+    return newPosition;
 }
 
 /*
+ * checks whether a cite is a first or subsequent reference
+ */
+Zotero.Integration.Session.prototype.checkFirstOrSubsequent = function(curr, citation ) {
+    var newPosition;
+
+    if (!this.citationsByItemID[curr.itemID]) {
+                curr.distanceToLastRef = 0;
+                curr.firstRef = citation.properties.index+1;
+                this.firstRef[curr.itemID] = citation.properties.index+1;
+                this.lastRef[curr.itemID] = citation.properties.index+1;
+                newPosition = Zotero.CSL.POSITION_FIRST;
+        } else if (this.citationsByItemID[curr.itemID][0].properties.index >= citation.properties.index) {
+                curr.distanceToLastRef = 0;
+                curr.firstRef = citation.properties.index+1;
+                this.firstRef[curr.itemID] = citation.properties.index+1;
+                this.lastRef[curr.itemID] = citation.properties.index+1;
+                newPosition = Zotero.CSL.POSITION_FIRST;
+    } else {
+                curr.distanceToLastRef = citation.properties.index+1 - this.lastRef[curr.itemID];
+                curr.firstRef = this.firstRef[curr.itemID];
+                this.lastRef[curr.itemID] = citation.properties.index+1;
+                newPosition = Zotero.CSL.POSITION_SUBSEQUENT;
+    }
+    return newPosition;
+}
+
+/*
+ * checks if cite has a prefix with terminal punctuation
+ */
+Zotero.Integration.Session.prototype.checkCiteContext = function(citationItem, newPosition) {
+    if (citationItem.prefix && citationItem.prefix.match(/.*[:;.?!][\s\"\"\'\']*$/)) {
+                citationItem.prefixPunctuation = true;
+    } else {
+                citationItem.prefixPunctuation = false;
+    }
+}
+    
+/*
+ * updates indexes
+ *
+ */
+Zotero.Integration.Session.prototype.updateCitePosition = function (curr, newPosition, citation, update) {
+    if(update && (curr.position || newPosition) && curr.position != newPosition) {
+                this.updateIndices[citation.properties.index] = true;
+    }
+  }
+
+/*
  * marks citations for update, where necessary
  */
 Zotero.Integration.Session.prototype.updateCitations = function(toIndex) {