gecko-dev/extensions/xforms/nsXFormsElementFactory.cpp

/* -*- 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 "nsXFormsElementFactory.h"
#include "nsIDOMDocument.h"
#include "nsXFormsAtoms.h"
#include "nsIDocument.h"
#include "nsIDOMNode.h"
#include "nsString.h"

// Form controls
NS_HIDDEN_(nsresult) NS_NewXFormsInputElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsSecretElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsTextAreaElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsGroupElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsOutputElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsRepeatElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsInsertElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsDeleteElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsUploadElement(nsIXTFElement **aElement);

/// @todo Having \<contextcontainer\> in the factory means that the item can be
/// used by a user in a document. Not optimal, as it is not a legal XForms tag,
/// but only a pseudo-element. But nsXFormsRepeat/SelectElement needs to be
/// able to create the tag, so is there a "backdoor way" to do that? (XXX)
NS_HIDDEN_(nsresult) NS_NewXFormsContextContainer(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsTriggerElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsSubmitElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsLabelElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsSelectElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsSelect1Element(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsItemElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsValueElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsChoicesElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsItemSetElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsRangeElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsCopyElement(nsIXTFElement **aElement);

//Action Module Elements
NS_HIDDEN_(nsresult) NS_NewXFormsDispatchElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsSendElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsSetFocusElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsResetElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsRebuildElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsRecalculateElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsRevalidateElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsRefreshElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsActionElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsLoadElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsSetValueElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsSetIndexElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsMessageElement(nsIXTFElement **aResult);

// XForms Controls. Additional Elements.
NS_HIDDEN_(nsresult) NS_NewXFormsMediatypeElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsHintElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsHelpElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsAlertElement(nsIXTFElement **aResult);

// XForms User Interface. The XForms Switch Module.
NS_HIDDEN_(nsresult) NS_NewXFormsToggleElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsCaseElement(nsIXTFElement **aResult);
NS_HIDDEN_(nsresult) NS_NewXFormsSwitchElement(nsIXTFElement **aResult);

NS_HIDDEN_(nsresult) NS_NewXFormsModelElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsSubmissionElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsInstanceElement(nsIXTFElement **aElement);
NS_HIDDEN_(nsresult) NS_NewXFormsStubElement(nsIXTFElement **aElement);

NS_IMPL_ISUPPORTS2(nsXFormsElementFactory,
                   nsIXTFElementFactory,
                   nsIDOMNSFeatureFactory)

NS_IMETHODIMP
nsXFormsElementFactory::CreateElement(const nsAString& aTagName,
                                      nsIXTFElement **aElement)
{
  if (aTagName.EqualsLiteral("model"))
    return NS_NewXFormsModelElement(aElement);
  if (aTagName.EqualsLiteral("instance"))
    return NS_NewXFormsInstanceElement(aElement);
  if (aTagName.EqualsLiteral("bind"))
    return NS_NewXFormsStubElement(aElement);
  if (aTagName.EqualsLiteral("input"))
    return NS_NewXFormsInputElement(aElement);
  if (aTagName.EqualsLiteral("secret"))
    return NS_NewXFormsSecretElement(aElement);
  if (aTagName.EqualsLiteral("textarea"))
    return NS_NewXFormsTextAreaElement(aElement);
  if (aTagName.EqualsLiteral("group"))
    return NS_NewXFormsGroupElement(aElement);
  if (aTagName.EqualsLiteral("output"))
    return NS_NewXFormsOutputElement(aElement);
  if (aTagName.EqualsLiteral("repeat"))
    return NS_NewXFormsRepeatElement(aElement);
  if (aTagName.EqualsLiteral("insert"))
    return NS_NewXFormsInsertElement(aElement);
  if (aTagName.EqualsLiteral("delete"))
    return NS_NewXFormsDeleteElement(aElement);
  if (aTagName.EqualsLiteral("contextcontainer") ||
      aTagName.EqualsLiteral("contextcontainer-inline"))
    return NS_NewXFormsContextContainer(aElement);
  if (aTagName.EqualsLiteral("label"))
    return NS_NewXFormsLabelElement(aElement);
  if (aTagName.EqualsLiteral("select"))
    return NS_NewXFormsSelectElement(aElement);
  if (aTagName.EqualsLiteral("select1"))
    return NS_NewXFormsSelect1Element(aElement);
  if (aTagName.EqualsLiteral("item"))
    return NS_NewXFormsItemElement(aElement);
  if (aTagName.EqualsLiteral("itemset"))
    return NS_NewXFormsItemSetElement(aElement);
  if (aTagName.EqualsLiteral("value"))
    return NS_NewXFormsValueElement(aElement);
  if (aTagName.EqualsLiteral("choices"))
    return NS_NewXFormsChoicesElement(aElement);
  if (aTagName.EqualsLiteral("dispatch"))
    return NS_NewXFormsDispatchElement(aElement);
  if (aTagName.EqualsLiteral("send"))
    return NS_NewXFormsSendElement(aElement);
  if (aTagName.EqualsLiteral("setfocus"))
    return NS_NewXFormsSetFocusElement(aElement);
  if (aTagName.EqualsLiteral("reset"))
    return NS_NewXFormsResetElement(aElement);
  if (aTagName.EqualsLiteral("rebuild"))
    return NS_NewXFormsRebuildElement(aElement);
  if (aTagName.EqualsLiteral("recalculate"))
    return NS_NewXFormsRecalculateElement(aElement);
  if (aTagName.EqualsLiteral("revalidate"))
    return NS_NewXFormsRevalidateElement(aElement);
  if (aTagName.EqualsLiteral("refresh"))
    return NS_NewXFormsRefreshElement(aElement);
  if (aTagName.EqualsLiteral("action"))
    return NS_NewXFormsActionElement(aElement);
  if (aTagName.EqualsLiteral("load"))
    return NS_NewXFormsLoadElement(aElement);
  if (aTagName.EqualsLiteral("setvalue"))
    return NS_NewXFormsSetValueElement(aElement);
  if (aTagName.EqualsLiteral("setindex"))
    return NS_NewXFormsSetIndexElement(aElement);
  if (aTagName.EqualsLiteral("message"))
    return NS_NewXFormsMessageElement(aElement);
  if (aTagName.EqualsLiteral("hint"))
    return NS_NewXFormsHintElement(aElement);
  if (aTagName.EqualsLiteral("help"))
    return NS_NewXFormsHelpElement(aElement);
  if (aTagName.EqualsLiteral("alert"))
    return NS_NewXFormsAlertElement(aElement);
  if (aTagName.EqualsLiteral("mediatype"))
    return NS_NewXFormsMediatypeElement(aElement);
  if (aTagName.EqualsLiteral("submission"))
    return NS_NewXFormsSubmissionElement(aElement);
  if (aTagName.EqualsLiteral("trigger"))
    return NS_NewXFormsTriggerElement(aElement);
  if (aTagName.EqualsLiteral("submit"))
    return NS_NewXFormsSubmitElement(aElement);
  if (aTagName.EqualsLiteral("toggle"))
    return NS_NewXFormsToggleElement(aElement);
  if (aTagName.EqualsLiteral("case"))
    return NS_NewXFormsCaseElement(aElement);
  if (aTagName.EqualsLiteral("switch"))
    return NS_NewXFormsSwitchElement(aElement);
  if (aTagName.EqualsLiteral("upload"))
    return NS_NewXFormsUploadElement(aElement);
  if (aTagName.EqualsLiteral("range"))
    return NS_NewXFormsRangeElement(aElement);
  if (aTagName.EqualsLiteral("copy"))
    return NS_NewXFormsCopyElement(aElement);

  *aElement = nsnull;
  return NS_ERROR_FAILURE;
}

NS_IMETHODIMP
nsXFormsElementFactory::HasFeature(nsISupports *aObject,
                                   const nsAString& aFeature,
                                   const nsAString& aVersion,
                                   PRBool *aReturn)
{
  *aReturn = (aFeature.EqualsLiteral("org.w3c.xforms.dom") &&
              aVersion.EqualsLiteral("1.0")) ||
             (aFeature.EqualsLiteral(NS_XFORMS_INSTANCE_OWNER) &&
              aVersion.EqualsLiteral("1.0"));
  return NS_OK;
}

NS_IMETHODIMP
nsXFormsElementFactory::GetFeature(nsISupports *aObject,
                                   const nsAString & aFeature,
                                   const nsAString & aVersion,
                                   nsISupports **aReturn)
{
  *aReturn = nsnull;
  if (aFeature.EqualsLiteral(NS_XFORMS_INSTANCE_OWNER) &&
      aVersion.EqualsLiteral("1.0")) {
    nsCOMPtr<nsIDOMNode> node(do_QueryInterface(aObject));
    NS_ENSURE_STATE(node);

    nsCOMPtr<nsIDOMDocument> domDoc;
    node->GetOwnerDocument(getter_AddRefs(domDoc));
    if (!domDoc) {
      // if node is nsIDOMDocument the ownerDocument is null.
      domDoc = do_QueryInterface(node);
    }
    NS_ENSURE_STATE(domDoc);

    nsCOMPtr<nsIDocument> doc(do_QueryInterface(domDoc));
    NS_ENSURE_STATE(doc);

    nsISupports* owner =
      NS_STATIC_CAST(nsISupports*,
                     doc->GetProperty(nsXFormsAtoms::instanceDocumentOwner));
    NS_IF_ADDREF(*aReturn = owner);
    return NS_OK;
  }

  return NS_ERROR_NOT_AVAILABLE;
}