RetroZilla/extensions/xforms/nsXFormsItemSetElement.cpp

401 lines
13 KiB
C++
Raw Normal View History

2015-10-21 05:03:22 +02:00
/* -*- 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
* IBM Corporation.
* Portions created by the Initial Developer are Copyright (C) 2004
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Brian Ryner <bryner@brianryner.com>
*
* 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 "nsIXFormsSelectChild.h"
#include "nsXFormsStubElement.h"
#include "nsIDOMHTMLOptGroupElement.h"
#include "nsString.h"
#include "nsCOMPtr.h"
#include "nsIXTFBindableElementWrapper.h"
#include "nsIDOMNodeList.h"
#include "nsIDocument.h"
#include "nsXFormsUtils.h"
#include "nsXFormsModelElement.h"
#include "nsIXFormsControlBase.h"
#include "nsIXFormsControl.h"
#include "nsIXFormsItemSetUIElement.h"
#include "nsXFormsDelegateStub.h"
#include "nsXFormsModelElement.h"
#include "nsIContent.h"
class nsXFormsItemSetElement : public nsXFormsDelegateStub,
public nsIXFormsSelectChild
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_IMETHOD OnCreated(nsIXTFBindableElementWrapper *aWrapper);
// nsIXTFElement overrides
NS_IMETHOD WillChangeDocument(nsIDOMDocument *aNewDocument);
NS_IMETHOD DocumentChanged(nsIDOMDocument *aNewDocument);
NS_IMETHOD WillChangeParent(nsIDOMElement *aNewParent);
NS_IMETHOD ParentChanged(nsIDOMElement *aNewParent);
NS_IMETHOD ChildInserted(nsIDOMNode *aChild, PRUint32 aIndex);
NS_IMETHOD ChildAppended(nsIDOMNode *aChild);
NS_IMETHOD WillRemoveChild(PRUint32 aIndex);
NS_IMETHOD BeginAddingChildren();
NS_IMETHOD DoneAddingChildren();
// nsIXFormsControlBase overrides
NS_IMETHOD Bind(PRBool *aContextChanged);
NS_IMETHOD Refresh();
NS_IMETHOD GetUsesSingleNodeBinding(PRBool *aUsesSNB);
// nsIXFormsSelectChild
NS_DECL_NSIXFORMSSELECTCHILD
/** The standard notification flags set on nsIXTFElement */
const PRUint32 kItemSetNotificationMask;
/** Constructor */
nsXFormsItemSetElement() :
kItemSetNotificationMask(nsIXTFElement::NOTIFY_WILL_CHANGE_DOCUMENT |
nsIXTFElement::NOTIFY_DOCUMENT_CHANGED |
nsIXTFElement::NOTIFY_WILL_CHANGE_PARENT |
nsIXTFElement::NOTIFY_PARENT_CHANGED |
nsIXTFElement::NOTIFY_CHILD_INSERTED |
nsIXTFElement::NOTIFY_CHILD_APPENDED |
nsIXTFElement::NOTIFY_WILL_REMOVE_CHILD |
nsIXTFElement::NOTIFY_BEGIN_ADDING_CHILDREN)
{};
};
NS_IMPL_ISUPPORTS_INHERITED1(nsXFormsItemSetElement,
nsXFormsDelegateStub,
nsIXFormsSelectChild)
NS_IMETHODIMP
nsXFormsItemSetElement::OnCreated(nsIXTFBindableElementWrapper *aWrapper)
{
nsresult rv = nsXFormsDelegateStub::OnCreated(aWrapper);
NS_ENSURE_SUCCESS(rv, rv);
aWrapper->SetNotificationMask(nsIXTFElement::NOTIFY_PARENT_CHANGED |
nsIXTFElement::NOTIFY_CHILD_INSERTED |
nsIXTFElement::NOTIFY_CHILD_APPENDED |
nsIXTFElement::NOTIFY_WILL_REMOVE_CHILD |
nsIXTFElement::NOTIFY_BEGIN_ADDING_CHILDREN);
aWrapper->SetNotificationMask(kItemSetNotificationMask);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::WillChangeDocument(nsIDOMDocument *aNewDocument)
{
SetRepeatState(eType_Unknown);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::DocumentChanged(nsIDOMDocument *aNewDocument)
{
nsXFormsDelegateStub::DocumentChanged(aNewDocument);
nsCOMPtr<nsIDOMNode> parent;
mElement->GetParentNode(getter_AddRefs(parent));
UpdateRepeatState(parent);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::WillChangeParent(nsIDOMElement *aNewParent)
{
SetRepeatState(eType_Unknown);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::ParentChanged(nsIDOMElement *aNewParent)
{
nsXFormsDelegateStub::ParentChanged(aNewParent);
UpdateRepeatState(aNewParent);
if (aNewParent)
Refresh();
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::ChildInserted(nsIDOMNode *aChild, PRUint32 aIndex)
{
Refresh();
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::ChildAppended(nsIDOMNode *aChild)
{
Refresh();
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::WillRemoveChild(PRUint32 aIndex)
{
Refresh();
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::BeginAddingChildren()
{
// Suppress child notifications until we're done getting children.
nsCOMPtr<nsIXTFElementWrapper> wrapper = do_QueryInterface(mElement);
NS_ASSERTION(wrapper, "huh? our element must be an xtf wrapper");
wrapper->SetNotificationMask(
kItemSetNotificationMask & ~(nsIXTFElement::NOTIFY_CHILD_INSERTED |
nsIXTFElement::NOTIFY_CHILD_APPENDED |
nsIXTFElement::NOTIFY_WILL_REMOVE_CHILD));
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::DoneAddingChildren()
{
// Unsuppress child notifications until we're done getting children.
nsCOMPtr<nsIXTFElementWrapper> wrapper = do_QueryInterface(mElement);
NS_ASSERTION(wrapper, "huh? our element must be an xtf wrapper");
wrapper->SetNotificationMask(kItemSetNotificationMask);
// Walk our children and get their anonymous content.
Refresh();
return NS_OK;
}
// nsIXFormsSelectChild
NS_IMETHODIMP
nsXFormsItemSetElement::SelectItemByValue(const nsAString &aValue, nsIDOMNode **aSelected)
{
NS_ENSURE_ARG_POINTER(aSelected);
NS_ENSURE_STATE(mElement);
*aSelected = nsnull;
// nsIXFormsItemSetUIElement is implemented by the XBL binding.
nsCOMPtr<nsIXFormsItemSetUIElement> uiItemSet(do_QueryInterface(mElement));
NS_ENSURE_STATE(uiItemSet);
nsCOMPtr<nsIDOMElement> anonContent;
uiItemSet->GetAnonymousItemSetContent(getter_AddRefs(anonContent));
NS_ENSURE_STATE(anonContent);
nsCOMPtr<nsIDOMNode> child, tmp;
anonContent->GetFirstChild(getter_AddRefs(child));
// Trying to select the first possible (generated) \<item\> element.
while (child) {
nsCOMPtr<nsIXFormsSelectChild> selectChild(do_QueryInterface(child));
if (selectChild) {
selectChild->SelectItemByValue(aValue, aSelected);
if (*aSelected) {
return NS_OK;
}
}
tmp.swap(child);
tmp->GetNextSibling(getter_AddRefs(child));
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::SelectItemByNode(nsIDOMNode *aNode,
nsIDOMNode **aSelected)
{
NS_ENSURE_ARG_POINTER(aSelected);
NS_ENSURE_STATE(mElement);
*aSelected = nsnull;
// nsIXFormsItemSetUIElement is implemented by the XBL binding.
nsCOMPtr<nsIXFormsItemSetUIElement> uiItemSet(do_QueryInterface(mElement));
NS_ENSURE_STATE(uiItemSet);
nsCOMPtr<nsIDOMElement> anonContent;
uiItemSet->GetAnonymousItemSetContent(getter_AddRefs(anonContent));
NS_ENSURE_STATE(anonContent);
nsCOMPtr<nsIDOMNode> child, tmp;
anonContent->GetFirstChild(getter_AddRefs(child));
// Trying to select the first possible (generated) \<item\> element.
while (child) {
nsCOMPtr<nsIXFormsSelectChild> selectChild(do_QueryInterface(child));
if (selectChild) {
selectChild->SelectItemByNode(aNode, aSelected);
if (*aSelected) {
return NS_OK;
}
}
tmp.swap(child);
tmp->GetNextSibling(getter_AddRefs(child));
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::Bind(PRBool *aContextChanged)
{
NS_ENSURE_ARG(aContextChanged);
*aContextChanged = PR_FALSE;
return BindToModel();
}
NS_IMETHODIMP
nsXFormsItemSetElement::Refresh()
{
// We need to create item elements for each element referenced by the
// nodeset. Each of these items will create an anonymous HTML option element
// which will return from GetAnonymousNodes. We then clone our template
// content and insert the cloned content as children of the HTML option.
if (!nsXFormsUtils::IsDocumentReadyForBind(mElement)) {
// not ready to bind yet, defer
nsXFormsModelElement::DeferElementBind(this);
return NS_OK;
}
nsCOMPtr<nsIModelElementPrivate> model;
nsCOMPtr<nsIDOMXPathResult> result;
nsresult rv = ProcessNodeBinding(NS_LITERAL_STRING("nodeset"),
nsIDOMXPathResult::ORDERED_NODE_SNAPSHOT_TYPE,
getter_AddRefs(result),
getter_AddRefs(model));
if (NS_FAILED(rv) | !result | !model)
return rv;
nsCOMPtr<nsIDOMNode> node, templateNode, cloneNode, tmpNode;
nsCOMPtr<nsIDOMElement> itemNode, itemWrapperNode, contextContainer;
nsCOMPtr<nsIDOMNodeList> templateNodes;
mElement->GetChildNodes(getter_AddRefs(templateNodes));
PRUint32 templateNodeCount = 0;
if (templateNodes)
templateNodes->GetLength(&templateNodeCount);
nsCOMPtr<nsIContent> content(do_QueryInterface(mElement));
NS_ENSURE_STATE(content);
nsCOMPtr<nsIDocument> doc = content->GetCurrentDoc();
nsCOMPtr<nsIDOMDocument> domDoc(do_QueryInterface(doc));
NS_ENSURE_STATE(domDoc);
PRUint32 nodeCount;
result->GetSnapshotLength(&nodeCount);
nsCOMPtr<nsIDOMNode> parent, tmp;
mElement->GetParentNode(getter_AddRefs(parent));
while (parent) {
if (nsXFormsUtils::IsXFormsElement(parent, NS_LITERAL_STRING("select1")) ||
nsXFormsUtils::IsXFormsElement(parent, NS_LITERAL_STRING("select"))) {
break;
}
tmp.swap(parent);
tmp->GetParentNode(getter_AddRefs(parent));
}
nsCOMPtr<nsIXFormsItemSetUIElement> uiItemSet(do_QueryInterface(mElement));
nsCOMPtr<nsIDOMElement> anonContent;
if (uiItemSet) {
uiItemSet->GetAnonymousItemSetContent(getter_AddRefs(anonContent));
}
NS_ENSURE_STATE(anonContent);
nsCOMPtr<nsIDOMNode> childNode, nodeReturn;
while (NS_SUCCEEDED(anonContent->GetFirstChild(getter_AddRefs(childNode))) &&
childNode) {
anonContent->RemoveChild(childNode, getter_AddRefs(nodeReturn));
}
for (PRUint32 i = 0; i < nodeCount; ++i) {
result->SnapshotItem(i, getter_AddRefs(node));
NS_ASSERTION(node, "incorrect snapshot length");
rv = domDoc->CreateElementNS(NS_LITERAL_STRING(NS_NAMESPACE_XFORMS),
NS_LITERAL_STRING("item"),
getter_AddRefs(itemNode));
NS_ENSURE_SUCCESS(rv, rv);
anonContent->AppendChild(itemNode, getter_AddRefs(tmpNode));
nsCOMPtr<nsIXFormsContextControl> ctx(do_QueryInterface(itemNode));
if (ctx) {
ctx->SetContext(node, i + 1, nodeCount);
}
// Clone the template content under the item
for (PRUint32 j = 0; j < templateNodeCount; ++j) {
templateNodes->Item(j, getter_AddRefs(templateNode));
templateNode->CloneNode(PR_TRUE, getter_AddRefs(cloneNode));
itemNode->AppendChild(cloneNode, getter_AddRefs(templateNode));
}
}
// refresh parent so that it has a chance to reflect the changes we just made
if (parent) {
nsCOMPtr<nsIXFormsControlBase> control = do_QueryInterface(parent);
if (control) {
control->Refresh();
}
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsItemSetElement::GetUsesSingleNodeBinding(PRBool *aUsesSNB)
{
NS_ENSURE_ARG_POINTER(aUsesSNB);
*aUsesSNB = PR_FALSE;
return NS_OK;
}
NS_HIDDEN_(nsresult)
NS_NewXFormsItemSetElement(nsIXTFElement **aResult)
{
*aResult = new nsXFormsItemSetElement();
if (!*aResult)
return NS_ERROR_OUT_OF_MEMORY;
NS_ADDREF(*aResult);
return NS_OK;
}