Back to index

lightning-sunbird  0.9+nobinonly
nsImageMapUtils.cpp
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsString.h"
00039 #include "nsReadableUtils.h"
00040 #include "nsCOMPtr.h"
00041 #include "nsIDocument.h"
00042 #include "nsIHTMLDocument.h"
00043 #include "nsIDOMDocument.h"
00044 #include "nsIDOMNode.h"
00045 #include "nsIDOMElement.h"
00046 #include "nsIDOMHTMLMapElement.h"
00047 #include "nsImageMapUtils.h"
00048 
00049 /*static*/
00050 already_AddRefed<nsIDOMHTMLMapElement>
00051 nsImageMapUtils::FindImageMap(nsIDocument *aDocument, 
00052                                                     const nsAString &aUsemap)
00053 {
00054   if (!aDocument)
00055     return nsnull;
00056 
00057   // We used to strip the whitespace from the usemap value as a Quirk,
00058   // but it was too quirky and didn't really work correctly - see bug
00059   // 87050
00060 
00061   if (aUsemap.IsEmpty())
00062     return nsnull;
00063 
00064   nsAString::const_iterator start, end;
00065   aUsemap.BeginReading(start);
00066   aUsemap.EndReading(end);
00067 
00068   PRInt32 hash = aUsemap.FindChar('#');
00069   if (hash > -1) {
00070     // aUsemap contains a '#', set start to point right after the '#'
00071     start.advance(hash + 1);
00072 
00073     if (start == end) {
00074       return nsnull; // aUsemap == "#"
00075     }
00076   }
00077 
00078   const nsAString& usemap = Substring(start, end);
00079 
00080   nsCOMPtr<nsIHTMLDocument> htmlDoc(do_QueryInterface(aDocument));
00081   if (htmlDoc) {
00082     nsIDOMHTMLMapElement* map = htmlDoc->GetImageMap(usemap);
00083     NS_IF_ADDREF(map);
00084     return map;
00085   } else {
00086     // For XHTML elements embedded in non-XHTML documents we get the
00087     // map by id since XHTML requires that where a "name" attribute
00088     // was used in HTML 4.01, the "id" attribute must be used in
00089     // XHTML. The attribute "name" is officially deprecated.  This
00090     // simplifies our life becase we can simply get the map with
00091     // getElementById().
00092     nsCOMPtr<nsIDOMDocument> domDoc(do_QueryInterface(aDocument));
00093     if (domDoc) {
00094       nsCOMPtr<nsIDOMElement> element;
00095       domDoc->GetElementById(usemap, getter_AddRefs(element));
00096 
00097       if (element) {
00098         nsIDOMHTMLMapElement* map;
00099         CallQueryInterface(element, &map);
00100         return map;
00101       }
00102     }
00103   }
00104   
00105   return nsnull;
00106 }