Mozilla/mozilla/accessible/src/nsHTMLIFrameRootAccessible.cpp

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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.org code.
 *
 * The Initial Developer of the Original Code is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s): 
 */

#include "nsHTMLIFrameRootAccessible.h"
#include "nsCOMPtr.h"
#include "nsIDocument.h"
#include "nsIPresShell.h"
#include "nsIPresContext.h"
#include "nsIContent.h"
#include "nsIFrame.h"
#include "nsIDocShell.h"
#include "nsIWebShell.h"
#include "nsIDocShellTreeItem.h"
#include "nsReadableUtils.h"


nsHTMLIFrameAccessible::nsHTMLIFrameAccessible(nsIPresShell* aShell, nsIDOMNode* aNode, nsIAccessible* aRoot):
  nsDOMAccessible(aShell, aNode)
{
  mRootAccessible = aRoot;
}

  /* attribute wstring accName; */
NS_IMETHODIMP nsHTMLIFrameAccessible::GetAccName(PRUnichar * *aAccName) 
{ 
  return mRootAccessible->GetAccName(aAccName);
}

/* nsIAccessible getAccFirstChild (); */
NS_IMETHODIMP nsHTMLIFrameAccessible::GetAccFirstChild(nsIAccessible **_retval)
{
  return mRootAccessible->GetAccFirstChild(_retval);
}

/* nsIAccessible getAccLastChild (); */
NS_IMETHODIMP nsHTMLIFrameAccessible::GetAccLastChild(nsIAccessible **_retval)
{
  return mRootAccessible->GetAccLastChild(_retval);
}

/* long getAccChildCount (); */
NS_IMETHODIMP nsHTMLIFrameAccessible::GetAccChildCount(PRInt32 *_retval)
{
  return mRootAccessible->GetAccChildCount(_retval);
}

/* unsigned long getAccRole (); */
NS_IMETHODIMP nsHTMLIFrameAccessible::GetAccRole(PRUint32 *_retval)
{
  return mRootAccessible->GetAccRole(_retval);
}

//-----------------------------------------------------
// construction 
//-----------------------------------------------------
nsHTMLIFrameRootAccessible::nsHTMLIFrameRootAccessible(nsIWeakReference* aShell, nsIDOMNode* aNode):
  nsRootAccessible(aShell)
{
  mRealDOMNode = aNode;
}

//-----------------------------------------------------
// destruction
//-----------------------------------------------------
nsHTMLIFrameRootAccessible::~nsHTMLIFrameRootAccessible()
{
}
  /* attribute wstring accName; */
NS_IMETHODIMP nsHTMLIFrameRootAccessible::GetAccName(PRUnichar * *aAccName) 
{ 
  nsCOMPtr<nsIPresShell> shell(do_QueryReferent(mPresShell));
  nsCOMPtr<nsIDocument> document;
  if (shell)
    shell->GetDocument(getter_AddRefs(document));
  if (document) {
    const nsString* docTitle = document->GetDocumentTitle();
    if (docTitle && !docTitle->IsEmpty()) {
      *aAccName = docTitle->ToNewUnicode();
      return NS_OK;
    }
  }
  *aAccName = ToNewUnicode(NS_LITERAL_STRING("Frame"));
  return NS_OK;  
}

  /* readonly attribute nsIAccessible accParent; */
NS_IMETHODIMP nsHTMLIFrameRootAccessible::GetAccParent(nsIAccessible * *_retval) 
{ 
  nsCOMPtr<nsIAccessible> accessible;
  if (NS_SUCCEEDED(GetHTMLIFrameAccessible(getter_AddRefs(accessible))))
    return accessible->GetAccParent(_retval);

  *_retval = nsnull;
  return NS_OK;
}

  /* nsIAccessible getAccNextSibling (); */
NS_IMETHODIMP nsHTMLIFrameRootAccessible::GetAccNextSibling(nsIAccessible **_retval) 
{
  nsCOMPtr<nsIAccessible> accessible;

  if (NS_SUCCEEDED(GetHTMLIFrameAccessible(getter_AddRefs(accessible))))
    return accessible->GetAccNextSibling(_retval);

  *_retval = nsnull;
  return NS_ERROR_NOT_IMPLEMENTED;
}

  /* nsIAccessible getAccPreviousSibling (); */
NS_IMETHODIMP nsHTMLIFrameRootAccessible::GetAccPreviousSibling(nsIAccessible **_retval) 
{
  nsCOMPtr<nsIAccessible> accessible;

  if (NS_SUCCEEDED(GetHTMLIFrameAccessible(getter_AddRefs(accessible))))
    return accessible->GetAccPreviousSibling(_retval);

  *_retval = nsnull;
  return NS_ERROR_NOT_IMPLEMENTED;
}

/* unsigned long getAccRole (); */
NS_IMETHODIMP nsHTMLIFrameRootAccessible::GetAccRole(PRUint32 *_retval)
{
  *_retval = ROLE_PANE;
  return NS_OK;
}

NS_IMETHODIMP nsHTMLIFrameRootAccessible::GetHTMLIFrameAccessible(nsIAccessible** aAcc)
{
  // Start by finding our PresShell and from that
  // we get our nsIDocShell in order to walk the DocShell tree
  nsCOMPtr<nsIPresShell> presShell(do_QueryReferent(mPresShell));
  nsCOMPtr<nsIDocShell> docShell;
  if (NS_SUCCEEDED(GetDocShellFromPS(presShell, getter_AddRefs(docShell)))) {
    // Now that we have the DocShell QI 
    // it to a tree item to find it's parent
    nsCOMPtr<nsIDocShellTreeItem> item(do_QueryInterface(docShell));
    if (item) {
      nsCOMPtr<nsIDocShellTreeItem> itemParent;
      item->GetParent(getter_AddRefs(itemParent));
      // QI to get the WebShell for the parent document
      nsCOMPtr<nsIDocShell> parentDocShell(do_QueryInterface(itemParent));
      if (parentDocShell) {
        // Get the PresShell/Content and 
        // Root Content Node of the parent document
        nsCOMPtr<nsIPresShell> parentPresShell;
        nsCOMPtr<nsIPresContext> parentPresContext;
        nsCOMPtr<nsIContent> rootContent;
        if (NS_SUCCEEDED(GetDocShellObjects(parentDocShell,
                                            getter_AddRefs(parentPresShell), 
                                            getter_AddRefs(parentPresContext),
                                            getter_AddRefs(rootContent)))) {
          // QI the DocShell (of this sub-doc) to a webshell
          nsCOMPtr<nsIWebShell> webShell(do_QueryInterface(docShell));
          if (webShell && parentPresShell && parentPresContext && rootContent) {
            // Now, find the Content in the parent document
            // that represents this sub-doc, 
            // we do that matching webshells
            nsCOMPtr<nsIContent> content;
            if (FindContentForWebShell(parentPresShell, 
                                       rootContent, 
                                       webShell,
                                       getter_AddRefs(content))) {
              // OK, we found the content node in the parent doc
              // that corresponds to this sub-doc
              // Get the frame for that content
              nsCOMPtr<nsIWeakReference> wr(getter_AddRefs(NS_GetWeakReference(parentPresShell)));
              nsIFrame* frame = nsnull;
              parentPresShell->GetPrimaryFrameFor(content, &frame);
#ifdef NS_DEBUG_X
              printf("** Found: Con:%p  Fr:%p", content, frame);
              char * name;
              if (GetNameForFrame(frame, &name)) {
                printf(" Name:[%s]", name);
                nsMemory::Free(name);
              }
              printf("\n");
#endif


              nsCOMPtr<nsIDOMNode> node(do_QueryInterface(content));
              nsCOMPtr<nsIAccessible> acc(do_QueryInterface(frame));

              *aAcc = CreateNewAccessible(acc, node, wr);
              NS_IF_ADDREF(*aAcc);

              return NS_OK;
            }
          }
        }
      }
    }
  }

  return NS_ERROR_FAILURE;
}