content/xul/templates/src/nsXULContentUtils.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Chris Waterson <waterson@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /*
  40
  41   A package of routines shared by the XUL content code.
  42
  43  */
  44
  45 #ifndef nsXULContentUtils_h__
  46 #define nsXULContentUtils_h__
  47
  48 #include "nsISupports.h"
  49
  50 class nsIAtom;
  51 class nsIContent;
  52 class nsIDocument;
  53 class nsIDOMNodeList;
  54 class nsIRDFNode;
  55 class nsCString;
  56 class nsString;
  57 class nsIRDFResource;
  58 class nsIRDFLiteral;
  59 class nsIRDFService;
  60 class nsINameSpaceManager;
  61 class nsIDateTimeFormat;
  62 class nsICollation;
  63
  64 class nsXULContentUtils
  65 {
  66 protected:
  67     static nsIRDFService* gRDF;
  68     static nsIDateTimeFormat* gFormat;
  69     static nsICollation *gCollation;
  70
  71     static PRBool gDisableXULCache;
  72
  73     static int
  74     DisableXULCacheChangedCallback(const char* aPrefName, void* aClosure);
  75
  76 public:
  77     static nsresult
  78     Init();
  79
  80     static nsresult
  81     Finish();
  82
  83     static nsresult
  84     FindChildByTag(nsIContent *aElement,
  85                    PRInt32 aNameSpaceID,
  86                    nsIAtom* aTag,
  87                    nsIContent **aResult);
  88
  89     static nsresult
  90     FindChildByResource(nsIContent* aElement,
  91                         nsIRDFResource* aResource,
  92                         nsIContent** aResult);
  93
  94     static nsresult
  95     GetElementResource(nsIContent* aElement, nsIRDFResource** aResult);
  96
  97     static nsresult
  98     GetTextForNode(nsIRDFNode* aNode, nsAString& aResult);
  99
 100     /**
 101      * Construct a URI from the element ID given.  This uses aElement as the
 102      * ref and aDocument's document URI as the base.  If aDocument's document
 103      * URI does not support refs, this will throw NS_ERROR_NOT_AVAILABLE.
 104      */
 105     static nsresult
 106     MakeElementURI(nsIDocument* aDocument, const nsAString& aElementID, nsCString& aURI);
 107
 108     static nsresult
 109     MakeElementResource(nsIDocument* aDocument, const nsAString& aElementID, nsIRDFResource** aResult);
 110
 111     /**
 112      * Extract the element ID from aURI.  Note that aURI must be an absolute
 113      * URI string in UTF8; the element ID is the ref from the URI.  If the
 114      * scheme does not support refs, then the ID will be empty.
 115      */
 116     static nsresult
 117     MakeElementID(nsIDocument* aDocument, const nsACString& aURI, nsAString& aElementID);
 118
 119     static nsresult
 120     GetResource(PRInt32 aNameSpaceID, nsIAtom* aAttribute, nsIRDFResource** aResult);
 121
 122     static nsresult
 123     GetResource(PRInt32 aNameSpaceID, const nsAString& aAttribute, nsIRDFResource** aResult);
 124
 125     static nsresult
 126     SetCommandUpdater(nsIDocument* aDocument, nsIContent* aElement);
 127
 128     static nsIRDFService*
 129     RDFService()
 130     {
 131         return gRDF;
 132     }
 133
 134     static nsICollation*
 135     GetCollation();
 136
 137 #define XUL_RESOURCE(ident, uri) static nsIRDFResource* ident
 138 #define XUL_LITERAL(ident, val)  static nsIRDFLiteral*  ident
 139 #include "nsXULResourceList.h"
 140 #undef XUL_RESOURCE
 141 #undef XUL_LITERAL
 142 };
 143
 144 #endif // nsXULContentUtils_h__