/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Mozilla XForms support. * * The Initial Developer of the Original Code is * Novell, Inc. * Portions created by the Initial Developer are Copyright (C) 2004 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Allan Beaufour * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsIXTFXMLVisualWrapper.h" #include "nsAutoPtr.h" #include "nsCOMPtr.h" #include "nsINameSpaceManager.h" #include "nsISchema.h" #include "nsIServiceManager.h" #include "nsMemory.h" #include "nsString.h" #include "nsSubstring.h" #include "nsIDOM3EventTarget.h" #include "nsIDOM3Node.h" #include "nsIDOMDOMImplementation.h" #include "nsIDOMDocument.h" #include "nsIDOMElement.h" #include "nsIDOMEventTarget.h" #include "nsIDOMNodeList.h" #include "nsIDOMXPathResult.h" #include "nsIDOMDocumentXBL.h" #include "nsXFormsControlStub.h" #include "nsIXFormsContextControl.h" #include "nsIXFormsRepeatElement.h" #include "nsIXFormsRepeatUIElement.h" #include "nsIXFormsRepeatItemElement.h" #include "nsXFormsAtoms.h" #include "nsXFormsModelElement.h" #include "nsXFormsUtils.h" #include "nsXFormsDelegateStub.h" #ifdef DEBUG //#define DEBUG_XF_REPEAT #endif /** * Implementation of the XForms \ control. * @see http://www.w3.org/TR/xforms/slice9.html#id2632123 * * There are two main functions of repeat: 1) "Expanding its children" and 2) * Maintaining the repeat-index. These are described here: * *

Expanding its children

* * On Refresh(), nsXFormsRepeatElement, does the following for each node in * the nodeset the \ tag is bound to: * * 1) Creates a new \ (nsXFormsContextContainer) * * 2) Clones all its children (that is children of its mElement) * and appends them as children to the nsXFormsContextContainer * * 3) Sets the context node and size for the nsXFormsContextContainer, so * that children can retrieve this through nsIXFormsContextControl. * * 4) Inserts the nsXFormsContextContainer into its visual content node. * * For example, this instance data: *
 * 
 *   
 *     val1
 *     val2
 *   
 * 
 * 
* * and this repeat: *
 * 
 *   Val: 
 * 
 * 
* * will be expanded to: *
 * 
 *   (anonymous content)          (XBL)
 *              (contextNode == "n[0]" and contextPosition == 1)
 *       Val:    (that is: 'val1')
 *     
 *              (contextNode == "n[1]" and contextPosition == 2)
 *       Val:    (that is: 'val2')
 *     
 *   (/anonymous content)         (XBL)
 * 
 * 
* * Besides being a practical way to implement \, it also means that it * is possible to CSS-style the individual "rows" in a \. * *

Maintaining the repeat-index

* * The repeat-index points to the current child contextcontainer selected, * which should be fairly easy, was it not for "nested repeats". * * If the DOM document has the following: *
 * 
 *   
 * 
 * 
* r_inner is cloned like all other elements: *
 * 
 *   (anonymous content)
 *     
 *       
 *     
 *     
 *       
 *     
 *   (/anonymous content)

 *   (DOM content -- not shown)
 *     
 *   (/DOM content)
 * 
 * 
* * So r_inner in fact exists three places; once in the DOM and twice in the * anonymous content of r_outer. The problem is that repeat-index can only be * set for one row for each repeat. The approach we use here is to check * whether we clone any \ elements in Refresh() using our own * CloneNode() function. If a \ is found, we mark the original (DOM) * \ inactive with regards to content (mIsParent), and basically just * use it to store a pointer to the current cloned \ * (mCurrentRepeat). We also store a pointer to the (DOM) parent in the cloned * repeat (mParent). * * There are two ways the repeat-index can be changed, 1) by \ * (nsXFormsSetIndexElement) and 2) by a \ getting * focus. We thus listen for focus-events in * nsXFormsContextContainer::HandleDefault(). * * If a \ changes the repeat-index, any nested repeats have their * repeat-index reset to their starting index (ResetInnerRepeats()). * *

Notes / todo

* * @todo Support attribute based repeats, as in: (XXX) * \ * @see http://www.w3.org/TR/xforms/index-all.html#ui.repeat.via.attrs * @see http://bugzilla.mozilla.org/show_bug.cgi?id=280368 * * @todo What happens if you set attributes on the parent repeat? * Should they propagate to the cloned repeats? (XXX) * * @note Should we handle @number? The spec. says that it's a "Optional hint * to the XForms Processor as to how many elements from the collection to * display." * @see https://bugzilla.mozilla.org/show_bug.cgi?id=302026 */ class nsXFormsRepeatElement : public nsXFormsDelegateStub, public nsIXFormsRepeatElement { protected: /** * The current repeat-index, 0 if no row is selected (can happen for nested * repeats) or there are no rows at all. * * @note That is the child \ at position mCurrentIndex - * 1 (indexes go from 1, DOM from 0). */ PRUint32 mCurrentIndex; /** * The maximum index value */ PRUint32 mMaxIndex; /** The parent repeat (nested repeats) */ nsCOMPtr mParent; /** * The nested level of the repeat. That is, the number of \ * elements above us in the anonymous content tree. Used by * ResetInnerRepeats(). */ PRUint32 mLevel; /** * The number of "repeat rows" the repeat currently have unrolled. */ PRUint32 mCurrentRowCount; /** * True while children are being added */ PRPackedBool mAddingChildren; /** * Are we a parent for nested repeats */ PRPackedBool mIsParent; /** * Is the repeat attribute-based (ie. created by using xf:repeat-* * attributes). * * @see http://www.w3.org/TR/xforms/slice9.html#ui.repeat.via.attrs */ PRPackedBool mIsAttributeBased; /** * A clone of the parent node (used when mIsAttributeBased), that is used by * InsertTemplateContent(). */ nsCOMPtr mParentClone; /** * The currently selected repeat (nested repeats) */ nsCOMPtr mCurrentRepeat; /** * Array of controls using the repeat-index */ nsCOMArray mIndexUsers; /** * Retrieves an integer attribute and checks its type. * * @param aName The attribute to retrieve * @param aVal The value * @param aType The attribute (Schema) type * @return Normal error codes, and NS_ERROR_NOT_AVAILABLE if * the attribute was empty/nonexistant */ nsresult GetIntAttr(const nsAString &aName, PRInt32 *aVal, const PRUint16 aType); /** * Set the repeat-index state for a given (nsIXFormsRepeatItemElement) * child. * * @param aPosition The position of the child (1-based) * @param aState The index state * @param aIsRefresh Is this part of a refresh event */ nsresult SetChildIndex(PRUint32 aPosition, PRBool aState, PRBool aIsRefresh = PR_FALSE); /** * Resets inner repeat indexes to 1 for first level of nested repeats of * |aNode|. * * @param aNode The node to search for repeats * @param aIsRefresh Is this part of a refresh event */ nsresult ResetInnerRepeats(nsIDOMNode *aNode, PRBool aIsRefresh); /** * Deep clones aSrc to aTarget, with special handling of \ elements * to take care of nested repeats. * * @param aSrc The source node * @param aTarget The target node */ nsresult CloneNode(nsIDOMNode *aSrc, nsIDOMNode **aTarget); PRBool IsBindingAttribute(const nsIAtom *aAttr) const; /** * Make sure that an index value is inside the valid index range. * * @param aIndex The index value to sanitize * @param aIsScroll Send scroll events if first or last index? */ void SanitizeIndex(PRUint32 *aIndex, PRBool aIsScroll = PR_FALSE); /** * Unroll the template content into the visual rows by cloning template * content and inserting into contextcontainers. */ nsresult UnrollRows(nsIDOMXPathResult *aNodeset); /** * Returns either the anonymous content of the repeat or null; */ already_AddRefed GetAnonymousContent(); /** * Insert the template content for a repeat node into the given node. * * @param aNode The node to insert content into. */ nsresult InsertTemplateContent(nsIDOMNode *aNode); /** * Get the XBL binding parent for a node. * * @param aNode The node to get binding parent for * @param aParent The returned binding parent */ nsresult GetBindingParent(nsIDOMNode *aNode, nsIDOMNode **aParent); // nsXFormsControlStub override virtual void AfterSetAttribute(nsIAtom *aName); public: NS_DECL_ISUPPORTS_INHERITED // nsIXTFBindableElement overrides NS_IMETHOD OnCreated(nsIXTFBindableElementWrapper *aWrapper); // nsIXTFElement overrides NS_IMETHOD OnDestroyed(); NS_IMETHOD BeginAddingChildren(); NS_IMETHOD DoneAddingChildren(); // nsIXFormsControl NS_IMETHOD Bind(PRBool *aContextChanged); NS_IMETHOD Refresh(); NS_IMETHOD TryFocus(PRBool* aOK); NS_IMETHOD IsEventTarget(PRBool *aOK); // nsIXFormsRepeatElement NS_DECL_NSIXFORMSREPEATELEMENT // nsXFormsRepeatElement nsXFormsRepeatElement() : mCurrentIndex(0), mMaxIndex(0), mLevel(1), mCurrentRowCount(0), mAddingChildren(PR_FALSE), mIsParent(PR_FALSE), mIsAttributeBased(PR_FALSE) {} #ifdef DEBUG_smaug virtual const char* Name() { return "repeat"; } #endif }; NS_IMPL_ISUPPORTS_INHERITED1(nsXFormsRepeatElement, nsXFormsDelegateStub, nsIXFormsRepeatElement) // nsIXTFXMLVisual NS_IMETHODIMP nsXFormsRepeatElement::OnCreated(nsIXTFBindableElementWrapper *aWrapper) { #ifdef DEBUG_XF_REPEAT printf("nsXFormsRepeatElement::OnCreated()\n"); #endif nsresult rv = nsXFormsDelegateStub::OnCreated(aWrapper); NS_ENSURE_SUCCESS(rv, rv); aWrapper->SetNotificationMask(kStandardNotificationMask | nsIXTFElement::NOTIFY_BEGIN_ADDING_CHILDREN | nsIXTFElement::NOTIFY_DONE_ADDING_CHILDREN); return NS_OK; } // nsIXTFElement NS_IMETHODIMP nsXFormsRepeatElement::OnDestroyed() { mIndexUsers.Clear(); return nsXFormsDelegateStub::OnDestroyed(); } NS_IMETHODIMP nsXFormsRepeatElement::BeginAddingChildren() { mAddingChildren = PR_TRUE; return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::DoneAddingChildren() { mAddingChildren = PR_FALSE; return NS_OK; } // nsIXFormsRepeatElement NS_IMETHODIMP nsXFormsRepeatElement::SetIndex(PRUint32 *aIndex, PRBool aIsRefresh) { NS_ENSURE_ARG(aIndex); #ifdef DEBUG_XF_REPEAT printf("\tSetindex to %d (current: %d, max: %d), aIsRefresh=%d\n", *aIndex, mCurrentIndex, mMaxIndex, aIsRefresh); #endif nsresult rv; // Set repeat-index if (mIsParent) { NS_ASSERTION(mCurrentRepeat, "How can we be a repeat parent without a child?"); // We're the parent of nested repeats, set through the correct repeat return mCurrentRepeat->SetIndex(aIndex, aIsRefresh); } // Do nothing if we are not showing anything if (mMaxIndex == 0) { SanitizeIndex(aIndex, PR_TRUE); mCurrentIndex = *aIndex; return NS_OK; } if (aIsRefresh && !mCurrentIndex) { // If we are refreshing, get existing index value from parent NS_ASSERTION(mParent, "SetIndex with aIsRefresh == PR_TRUE for a non-nested repeat?!"); rv = mParent->GetIndex(aIndex); NS_ENSURE_SUCCESS(rv, rv); } // Check min. and max. value SanitizeIndex(aIndex, PR_TRUE); // Do nothing if setting to existing value if (!aIsRefresh && mCurrentIndex && *aIndex == mCurrentIndex) return NS_OK; #ifdef DEBUG_XF_REPEAT printf("\tWill set index to %d\n", *aIndex); #endif // Set the repeat-index rv = SetChildIndex(*aIndex, PR_TRUE, aIsRefresh); NS_ENSURE_SUCCESS(rv, rv); // Unset previous repeat-index if (mCurrentIndex) { // We had the previous selection, unset directly SetChildIndex(mCurrentIndex, PR_FALSE, aIsRefresh); } if (mParent) { // Selection is in another repeat, inform parent (it will inform the // previous owner of its new state) rv = mParent->SetCurrentRepeat(this, *aIndex); NS_ENSURE_SUCCESS(rv, rv); } // Set current index to new value mCurrentIndex = *aIndex; // Inform of index change mParent ? mParent->IndexHasChanged() : IndexHasChanged(); return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::GetIndex(PRUint32 *aIndex) { NS_ENSURE_ARG(aIndex); if (mIsParent) { if (!mCurrentRepeat) { *aIndex = 0; return NS_OK; } return mCurrentRepeat->GetIndex(aIndex); } *aIndex = mCurrentIndex; return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::Deselect(void) { if (!mCurrentIndex) return NS_OK; nsresult rv = SetChildIndex(mCurrentIndex, PR_FALSE); if (NS_SUCCEEDED(rv)) { mCurrentIndex = 0; } return rv; } NS_IMETHODIMP nsXFormsRepeatElement::GetStartingIndex(PRUint32 *aRes) { NS_ENSURE_ARG(aRes); nsresult rv = GetIntAttr(NS_LITERAL_STRING("startindex"), (PRInt32*) aRes, nsISchemaBuiltinType::BUILTIN_TYPE_POSITIVEINTEGER); if (NS_FAILED(rv)) { *aRes = 1; } SanitizeIndex(aRes); return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::SetCurrentRepeat(nsIXFormsRepeatElement *aRepeat, PRUint32 aIndex) { // Deselect the previous owner if (mCurrentRepeat && aRepeat != mCurrentRepeat) { nsresult rv = mCurrentRepeat->Deselect(); NS_ENSURE_SUCCESS(rv, rv); } mCurrentRepeat = aRepeat; // Check aIndex. If it is 0, we should intialize to the starting index if (!aIndex) { GetStartingIndex(&aIndex); } mCurrentIndex = aIndex; return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::GetCurrentRepeatRow(nsIDOMNode **aRow) { if (mCurrentRepeat) { // nested repeats return mCurrentRepeat->GetCurrentRepeatRow(aRow); } nsCOMPtr anon = GetAnonymousContent(); NS_ENSURE_STATE(anon); nsCOMPtr children; anon->GetChildNodes(getter_AddRefs(children)); NS_ENSURE_STATE(children); nsCOMPtr child; children->Item(mCurrentIndex - 1, // Indexes are 1-based, the DOM is 0-based getter_AddRefs(child)); NS_IF_ADDREF(*aRow = child); return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::AddIndexUser(nsIXFormsControl *aControl) { nsresult rv = NS_OK; if (mIndexUsers.IndexOf(aControl) == -1 && !mIndexUsers.AppendObject(aControl)) rv = NS_ERROR_FAILURE; return rv; } NS_IMETHODIMP nsXFormsRepeatElement::RemoveIndexUser(nsIXFormsControl *aControl) { return mIndexUsers.RemoveObject(aControl) ? NS_OK : NS_ERROR_FAILURE; } NS_IMETHODIMP nsXFormsRepeatElement::IndexHasChanged() { NS_ENSURE_STATE(mModel); /// /// @bug We need to handle \ elements too (XXX) // copy the index array, as index users might add/remove themselves when // they are rebound and refreshed(). nsCOMArray indexes(mIndexUsers); nsresult rv; for (PRInt32 i = 0; i < indexes.Count(); ++i) { nsCOMPtr control = indexes[i]; rv = mModel->ForceRebind(control); NS_ENSURE_SUCCESS(rv, rv); } return NS_OK; } // NB: CloneNode() assumes that this always succeeds NS_IMETHODIMP nsXFormsRepeatElement::GetIsParent(PRBool *aIsParent) { NS_ENSURE_ARG(aIsParent); *aIsParent = mIsParent; return NS_OK; } // NB: CloneNode() assumes that this always succeeds NS_IMETHODIMP nsXFormsRepeatElement::SetIsParent(PRBool aIsParent) { mIsParent = aIsParent; return NS_OK; } // NB: CloneNode() assumes that this always succeeds NS_IMETHODIMP nsXFormsRepeatElement::SetParent(nsIXFormsRepeatElement *aParent) { mParent = aParent; // We're an inner repeat owned by a parent, let it control whether we are // selected or not. Deselect(); return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::GetParent(nsIXFormsRepeatElement **aParent) { NS_ENSURE_ARG_POINTER(aParent); NS_IF_ADDREF(*aParent = mParent); return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::SetLevel(PRUint32 aLevel) { mLevel = aLevel; return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::GetLevel(PRUint32 *aLevel) { NS_ENSURE_ARG(aLevel); *aLevel = mLevel; return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::HandleNodeInsert(nsIDOMNode *aNode) { nsCOMPtr anon = GetAnonymousContent(); if (!anon) { return NS_OK; } nsCOMPtr node(do_QueryInterface(aNode)); NS_ENSURE_STATE(node); // XXX, badness^2: If it is a insert we have to refresh before we can // figure out whether the node is in our nodeset... refactor this so // repeat actually gets the nodeset in Bind() and then uses it refresh, // then we can "just" re-evaluate the nodeset, and only refresh if the // node actually hits this repeat // XXX, moreover it is also wrong to refresh at this point. It will happen // in insert processing (and possibly deferred...) nsresult rv = Refresh(); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr child; anon->GetFirstChild(getter_AddRefs(child)); PRUint32 index = 1; while (child) { nsCOMPtr context(do_QueryInterface(child)); NS_ASSERTION(context, "repeat child not implementing nsIXFormsContextControl?!"); nsAutoString modelID; PRInt32 position, size; nsCOMPtr boundNode; rv = context->GetContext(modelID, getter_AddRefs(boundNode), &position, &size); NS_ENSURE_SUCCESS(rv, rv); PRBool sameNode = PR_FALSE; node->IsSameNode(boundNode, &sameNode); if (sameNode) { rv = SetIndex(&index, PR_FALSE); NS_ENSURE_SUCCESS(rv, rv); break; } nsCOMPtr tmp; child->GetNextSibling(getter_AddRefs(tmp)); child.swap(tmp); ++index; } return NS_OK; } // nsXFormsControl NS_IMETHODIMP nsXFormsRepeatElement::Bind(PRBool *aContextChanged) { #ifdef DEBUG_XF_REPEAT printf("nsXFormsRepeatElement::Bind()\n"); #endif NS_ENSURE_ARG(aContextChanged); if (!nsXFormsUtils::IsDocumentReadyForBind(mElement)) { nsXFormsModelElement::DeferElementBind(this); *aContextChanged = PR_FALSE; return NS_OK_XFORMS_DEFERRED; } nsresult rv = BindToModel(); NS_ENSURE_SUCCESS(rv, rv); *aContextChanged = PR_TRUE; return NS_OK; } nsresult nsXFormsRepeatElement::GetBindingParent(nsIDOMNode *aNode, nsIDOMNode **aParent) { NS_ENSURE_ARG_POINTER(aNode); NS_ENSURE_ARG_POINTER(aParent); nsCOMPtr domDoc; aNode->GetOwnerDocument(getter_AddRefs(domDoc)); nsCOMPtr docXBL(do_QueryInterface(domDoc)); NS_ENSURE_STATE(docXBL); nsCOMPtr parent; docXBL->GetBindingParent(aNode, getter_AddRefs(parent)); NS_IF_ADDREF(*aParent = parent); return NS_OK; } nsresult nsXFormsRepeatElement::InsertTemplateContent(nsIDOMNode *aNode) { NS_ENSURE_ARG_POINTER(aNode); nsresult rv; nsCOMPtr insertionPoint; // If we are attribute based we need to clone our parent (the element with // the repeat-* attributes), and insert that as the first child. if (mIsAttributeBased) { NS_ENSURE_STATE(mParentClone); nsCOMPtr parentClone; rv = mParentClone->CloneNode(PR_FALSE, getter_AddRefs(parentClone)); NS_ENSURE_SUCCESS(rv, rv); rv = aNode->AppendChild(parentClone, getter_AddRefs(insertionPoint)); NS_ENSURE_SUCCESS(rv, rv); } else { insertionPoint = aNode; } // Get template content nsCOMPtr child; if (mIsAttributeBased) { // If we are attribute based, we need to get our binding parent and get // its first child or we will be looking at the binding document. nsCOMPtr parent; rv = GetBindingParent(mElement, getter_AddRefs(parent)); NS_ENSURE_SUCCESS(rv, rv); rv = parent->GetFirstChild(getter_AddRefs(child)); NS_ENSURE_SUCCESS(rv, rv); } else { rv = mElement->GetFirstChild(getter_AddRefs(child)); NS_ENSURE_SUCCESS(rv, rv); } // Clone template while (child) { nsCOMPtr childClone; rv = CloneNode(child, getter_AddRefs(childClone)); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr newNode; rv = insertionPoint->AppendChild(childClone, getter_AddRefs(newNode)); NS_ENSURE_SUCCESS(rv, rv); rv = child->GetNextSibling(getter_AddRefs(newNode)); NS_ENSURE_SUCCESS(rv, rv); child = newNode; } return NS_OK; } // XXX: If repeat is moved to a new position, we need to clear the unrolled // content and clear mParentClone nsresult nsXFormsRepeatElement::UnrollRows(nsIDOMXPathResult *aNodeset) { #ifdef DEBUG_XF_REPEAT printf("nsXFormsRepeatElement::UnrollRows()\n"); #endif NS_ENSURE_STATE(mElement); nsCOMPtr anon = GetAnonymousContent(); if (!anon) { return NS_OK; } nsresult rv; if (!aNodeset || !mModel) { mMaxIndex = 0; } else { PRUint32 contextSize; rv = aNodeset->GetSnapshotLength(&contextSize); NS_ENSURE_SUCCESS(rv, rv); mMaxIndex = contextSize; } #ifdef DEBUG_XF_REPEAT printf("\tmMaxIndex: %d, mCurrentRowCount: %d\n", mMaxIndex, mCurrentRowCount); #endif // STEP 1: Remove rows nsCOMPtr tmp; if (mMaxIndex < mCurrentRowCount) { for (PRUint32 i = mMaxIndex; i < mCurrentRowCount; ++i) { nsCOMPtr lastChild; rv = anon->GetLastChild(getter_AddRefs(lastChild)); NS_ENSURE_SUCCESS(rv, rv); rv = anon->RemoveChild(lastChild, getter_AddRefs(tmp)); NS_ENSURE_SUCCESS(rv, rv); } } else if (mMaxIndex > mCurrentRowCount) { // STEP 2: Add rows nsCOMPtr domDoc; rv = anon->GetOwnerDocument(getter_AddRefs(domDoc)); NS_ENSURE_SUCCESS(rv, rv); for (PRUint32 i = mCurrentRowCount; i < mMaxIndex; ++i) { // Create nsCOMPtr container; rv = domDoc->CreateElementNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("contextcontainer"), getter_AddRefs(container)); NS_ENSURE_SUCCESS(rv, rv); container->SetAttribute(NS_LITERAL_STRING("class"), NS_LITERAL_STRING("xf-repeat-item")); rv = anon->AppendChild(container, getter_AddRefs(tmp)); NS_ENSURE_SUCCESS(rv, rv); } } // Repeat has no content if (!mMaxIndex) { mCurrentRowCount = 0; return NS_OK; } // STEP 3: Update context on rows nsCOMPtr child; rv = anon->GetFirstChild(getter_AddRefs(child)); NS_ENSURE_SUCCESS(rv, rv); for (PRUint32 i = 0; i < mMaxIndex; ++i) { NS_ASSERTION(child, "Unrolled content does not match index size?!"); // Get context node nsCOMPtr contextNode; rv = aNodeset->SnapshotItem(i, getter_AddRefs(contextNode)); NS_ENSURE_SUCCESS(rv, rv); // Set context node, position, and size nsCOMPtr childContext = do_QueryInterface(child); NS_ASSERTION(childContext, "content child not implementing nsIXFormsContextControl?!"); rv = childContext->SetContext(contextNode, i + 1, mMaxIndex); NS_ENSURE_SUCCESS(rv, rv); // Next child rv = child->GetNextSibling(getter_AddRefs(tmp)); NS_ENSURE_SUCCESS(rv, rv); tmp.swap(child); } // Rows deleted, nothing more to do if (mCurrentRowCount >= mMaxIndex) { mCurrentRowCount = mMaxIndex; return NS_OK; } // STEP 4: Insert template content into newly created rows // If we are attribute based, prepare a clone of our parent if (mIsAttributeBased && !mParentClone) { nsCOMPtr parent; rv = mElement->GetParentNode(getter_AddRefs(parent)); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr parentClone; rv = parent->CloneNode(PR_FALSE, getter_AddRefs(parentClone)); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr parentCloneEl(do_QueryInterface(parentClone)); NS_ENSURE_STATE(parentCloneEl); // Remove all possible repeat-* attributes parentCloneEl->RemoveAttributeNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("repeat-model")); parentCloneEl->RemoveAttributeNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("repeat-bind")); parentCloneEl->RemoveAttributeNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("repeat-nodeset")); parentCloneEl->RemoveAttributeNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("repeat-startindex")); parentCloneEl->RemoveAttributeNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("repeat-number")); // Save parent clone mParentClone = parentCloneEl; } nsCOMPtr containerList; rv = anon->GetChildNodes(getter_AddRefs(containerList)); NS_ENSURE_SUCCESS(rv, rv); for (PRUint32 j = mCurrentRowCount; j < mMaxIndex; ++j) { nsCOMPtr container; rv = containerList->Item(j, getter_AddRefs(container)); NS_ENSURE_SUCCESS(rv, rv); rv = InsertTemplateContent(container); NS_ENSURE_SUCCESS(rv, rv); } mCurrentRowCount = mMaxIndex; return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::Refresh() { #ifdef DEBUG_XF_REPEAT printf("nsXFormsRepeatElement::Refresh()\n"); #endif if (mAddingChildren || mIsParent) return NS_OK; nsPostRefresh postRefresh = nsPostRefresh(); PRUint32 oldIndex = mCurrentIndex; /// @todo The spec says: "This node-set must consist of contiguous child /// element nodes, with the same local name and namespace name of a common /// parent node. The behavior of element repeat with respect to /// non-homogeneous node-sets is undefined." /// @see http://www.w3.org/TR/xforms/slice9.html#ui-repeat /// /// Can/should we check this somehow? (XXX) // Get the nodeset we are bound to nsresult rv; nsCOMPtr result; rv = ProcessNodeBinding(NS_LITERAL_STRING("nodeset"), nsIDOMXPathResult::ORDERED_NODE_SNAPSHOT_TYPE, getter_AddRefs(result)); NS_ENSURE_SUCCESS(rv, rv); // Unroll the repeat rows rv = UnrollRows(result); NS_ENSURE_SUCCESS(rv, rv); // Maintain the index if (mCurrentIndex || !mMaxIndex) { // Somebody might have been fooling around with our children since last // refresh (either using delete or through script). Or we might have an // empty nodeset. So fix the index value. SanitizeIndex(&mCurrentIndex); } else if (mMaxIndex) { // repeat-index has not been initialized, set it. if (!mParent) { GetStartingIndex(&mCurrentIndex); // Inform listeners of initial index value IndexHasChanged(); } else if (mLevel > 1) { // Set repeat-index for inner repeats. If parent // element is selected then mCurrentIndex is setted on starting index. nsCOMPtr temp = mElement; nsCOMPtr parent; nsCOMPtr context; while (!context) { rv = temp->GetParentNode(getter_AddRefs(parent)); NS_ENSURE_SUCCESS(rv, rv); if (!parent) break; context = do_QueryInterface(parent); temp.swap(parent); } if (context) { PRBool hasIndex = PR_FALSE; context->GetIndexState(&hasIndex); if (hasIndex) { PRUint32 index = 0; GetStartingIndex(&index); SetIndex(&index, PR_FALSE); } } return NS_OK; } } // If we have the repeat-index, set it. if (mCurrentIndex) { SetChildIndex(mCurrentIndex, PR_TRUE, PR_TRUE); } if (mCurrentIndex != oldIndex) { mParent ? mParent->IndexHasChanged() : IndexHasChanged(); } return NS_OK; } // nsXFormsRepeatElement nsresult nsXFormsRepeatElement::SetChildIndex(PRUint32 aPosition, PRBool aState, PRBool aIsRefresh) { #ifdef DEBUG_XF_REPEAT printf("\tTrying to set index #%d to state '%d', aIsRefresh=%d\n", aPosition, aState, aIsRefresh); #endif nsCOMPtr anon = GetAnonymousContent(); if (!anon) return NS_OK; nsCOMPtr children; anon->GetChildNodes(getter_AddRefs(children)); NS_ENSURE_STATE(children); PRUint32 index = aPosition - 1; // Indexes are 1-based, the DOM is 0-based; nsCOMPtr child; children->Item(index, getter_AddRefs(child)); nsCOMPtr repeatItem(do_QueryInterface(child)); NS_ASSERTION(repeatItem, "repeat child not implementing nsIXFormsRepeatItemElement?!"); nsresult rv; PRBool curState; rv = repeatItem->GetIndexState(&curState); NS_ENSURE_SUCCESS(rv, rv); if (curState != aState) { rv = repeatItem->SetIndexState(aState); NS_ENSURE_SUCCESS(rv, rv); if (aState) { // Reset inner repeats rv = ResetInnerRepeats(child, aIsRefresh); NS_ENSURE_SUCCESS(rv, rv); } } return NS_OK; } void nsXFormsRepeatElement::SanitizeIndex(PRUint32 *aIndex, PRBool aIsScroll) { if (!aIndex) return; #ifdef DEBUG_XF_REPEAT printf("nsXFormsRepeatElement::SanitizeIndex()\n"); printf("\tCurrent index: %d\n", *aIndex); #endif if (*aIndex < 1) { *aIndex = mMaxIndex ? 1 : 0; if (aIsScroll) nsXFormsUtils::DispatchEvent(mElement, eEvent_ScrollFirst); } else if (*aIndex > mMaxIndex) { *aIndex = mMaxIndex; if (aIsScroll) nsXFormsUtils::DispatchEvent(mElement, eEvent_ScrollLast); } #ifdef DEBUG_XF_REPEAT printf("\tNew index: %d\n", *aIndex); #endif } nsresult nsXFormsRepeatElement::ResetInnerRepeats(nsIDOMNode *aNode, PRBool aIsRefresh) { #ifdef DEBUG_XF_REPEAT printf("\taIsRefresh: %d\n", aIsRefresh); #endif nsCOMPtr element = do_QueryInterface(aNode); if (!element) return NS_ERROR_FAILURE; nsCOMPtr nodeList; nsresult rv; nsCOMPtr anon = GetAnonymousContent(); NS_ENSURE_STATE(anon); rv = element->GetElementsByTagNameNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS), NS_LITERAL_STRING("repeat"), getter_AddRefs(nodeList)); NS_ENSURE_SUCCESS(rv, rv); PRUint32 childCount = 0; nodeList->GetLength(&childCount); nsCOMPtr node; nsCOMPtr repeat; for (PRUint32 i = 0; i < childCount; ++i) { nodeList->Item(i, getter_AddRefs(node)); repeat = do_QueryInterface(node); NS_ENSURE_STATE(repeat); PRUint32 level; repeat->GetLevel(&level); if (level == mLevel + 1) { PRUint32 index; repeat->GetStartingIndex(&index); repeat->SetIndex(&index, aIsRefresh); } } return NS_OK; } nsresult nsXFormsRepeatElement::CloneNode(nsIDOMNode *aSrc, nsIDOMNode **aTarget) { NS_ENSURE_ARG(aSrc); NS_ENSURE_ARG_POINTER(aTarget); // Clone aSrc nsresult rv; rv = aSrc->CloneNode(PR_FALSE, aTarget); NS_ENSURE_SUCCESS(rv, rv); // Check whether we have cloned a repeat if (nsXFormsUtils::IsXFormsElement(aSrc, NS_LITERAL_STRING("repeat"))) { nsCOMPtr repSource = do_QueryInterface(aSrc); NS_ENSURE_STATE(repSource); nsCOMPtr repClone = do_QueryInterface(*aTarget); NS_ENSURE_STATE(repClone); // Find top-most parent of these repeats nsCOMPtr parent = repSource; nsCOMPtr temp; rv = parent->GetParent(getter_AddRefs(temp)); NS_ENSURE_SUCCESS(rv, rv); while (temp) { temp.swap(parent); rv = parent->GetParent(getter_AddRefs(temp)); NS_ENSURE_SUCCESS(rv, rv); } // Set parent and level on clone PRUint32 level; repSource->GetLevel(&level); repClone->SetLevel(level + 1); repClone->SetParent(parent); // Inform parent of new status, if it does not know already PRBool isParent; parent->GetIsParent(&isParent); if (!isParent) { rv = parent->SetCurrentRepeat(repClone, 0); NS_ENSURE_SUCCESS(rv, rv); parent->SetIsParent(PR_TRUE); } } // Clone children of aSrc nsCOMPtr tmp; nsCOMPtr childNodes; aSrc->GetChildNodes(getter_AddRefs(childNodes)); PRUint32 count = 0; if (childNodes) childNodes->GetLength(&count); for (PRUint32 i = 0; i < count; ++i) { nsCOMPtr child; childNodes->Item(i, getter_AddRefs(child)); if (child) { nsCOMPtr clone; CloneNode(child, getter_AddRefs(clone)); if (clone) { rv = (*aTarget)->AppendChild(clone, getter_AddRefs(tmp)); NS_ENSURE_SUCCESS(rv, rv); } } } return NS_OK; } NS_IMETHODIMP nsXFormsRepeatElement::TryFocus(PRBool *aOK) { if (!mCurrentIndex) { *aOK = PR_FALSE; return NS_OK; } nsCOMPtr anon = GetAnonymousContent(); if (!anon) return NS_OK; /** * "Setting focus to a repeating structure sets the focus to * the repeat item represented by the repeat index." * @see http://www.w3.org/TR/xforms/slice10.html#action-setfocus */ nsCOMPtr children; anon->GetChildNodes(getter_AddRefs(children)); NS_ENSURE_STATE(children); nsCOMPtr child; children->Item(mCurrentIndex - 1, // Indexes are 1-based, the DOM is 0-based getter_AddRefs(child)); nsCOMPtr control = do_QueryInterface(child); NS_ENSURE_STATE(control); return control->TryFocus(aOK); } NS_IMETHODIMP nsXFormsRepeatElement::IsEventTarget(PRBool *aOK) { *aOK = PR_FALSE; return NS_OK; } /** * @todo This function will be part of the general schema support, so it will * only live here until this is implemented there. (XXX) */ nsresult nsXFormsRepeatElement::GetIntAttr(const nsAString &aName, PRInt32 *aVal, const PRUint16 aType) { nsresult rv = NS_OK; NS_ENSURE_ARG_POINTER(aVal); nsAutoString attrVal; mElement->GetAttribute(aName, attrVal); /// @todo Is this the correct error to return? We need to distinguish between /// an empty attribute and other errors. (XXX) if (attrVal.IsEmpty()) { return NS_ERROR_NOT_AVAILABLE; } PRInt32 errCode; /// @todo ToInteger is extremely large, "xxx23xxx" will be parsed with no errors /// as "23"... (XXX) *aVal = attrVal.ToInteger(&errCode); NS_ENSURE_TRUE(errCode == 0, NS_ERROR_FAILURE); /// /// @todo Check maximum values? (XXX) switch (aType) { case nsISchemaBuiltinType::BUILTIN_TYPE_NONNEGATIVEINTEGER: if (*aVal < 0) { rv = NS_ERROR_FAILURE; } break; case nsISchemaBuiltinType::BUILTIN_TYPE_POSITIVEINTEGER: if (*aVal <= 0) { rv = NS_ERROR_FAILURE; } break; case nsISchemaBuiltinType::BUILTIN_TYPE_ANYTYPE: break; default: rv = NS_ERROR_INVALID_ARG; // or NOT_IMPLEMENTED? break; } return rv; } PRBool nsXFormsRepeatElement::IsBindingAttribute(const nsIAtom *aAttr) const { if (aAttr == nsXFormsAtoms::bind || aAttr == nsXFormsAtoms::nodeset || aAttr == nsXFormsAtoms::model) { return PR_TRUE; } return PR_FALSE; } void nsXFormsRepeatElement::AfterSetAttribute(nsIAtom *aName) { if (aName == nsXFormsAtoms::attrBased) { PRBool isAttributeBased; nsresult rv = mElement->HasAttributeNS(NS_LITERAL_STRING(NS_NAMESPACE_MOZ_XFORMS_TYPE), NS_LITERAL_STRING("attrBased"), &isAttributeBased); if (NS_SUCCEEDED(rv)) mIsAttributeBased = isAttributeBased; } nsXFormsDelegateStub::AfterSetAttribute(aName); } already_AddRefed nsXFormsRepeatElement::GetAnonymousContent() { nsIDOMElement* anon = nsnull; nsCOMPtr uiElement(do_QueryInterface(mElement)); if (uiElement) { // addrefs uiElement->GetAnonymousRepeatContent(&anon); } return anon; } // Factory NS_HIDDEN_(nsresult) NS_NewXFormsRepeatElement(nsIXTFElement **aResult) { *aResult = new nsXFormsRepeatElement(); if (!*aResult) return NS_ERROR_OUT_OF_MEMORY; NS_ADDREF(*aResult); return NS_OK; }