nsIScriptElement.h

/* -*- 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. * * The Initial Developer of the Original Code is * Netscape Communications. * Portions created by the Initial Developer are Copyright (C) 2001 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Vidur Apparao <vidur@netscape.com> (original author) * * 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 ***** */#ifndef nsIScriptElement_h___#define nsIScriptElement_h___#include "nsISupports.h"#include "nsIURI.h"#include "nsCOMPtr.h"#include "nsIScriptLoaderObserver.h"#define NS_ISCRIPTELEMENT_IID \{ 0x4b916da5, 0x82c4, 0x45ab, \ { 0x99, 0x15, 0xcc, 0xcd, 0x9e, 0x2c, 0xb1, 0xe6 } }/** * Internal interface implemented by script elements */00054class nsIScriptElement : public nsIScriptLoaderObserver {
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTELEMENT_IID)
nsIScriptElement()
: mLineNumber(0),
mIsEvaluated(PR_FALSE),
mMalformed(PR_FALSE),
mDoneAddingChildren(PR_TRUE)
{
}
/** * Content type identifying the scripting language. Can be empty, in * which case javascript will be assumed. */virtualvoidGetScriptType(nsAString& type) = 0;
/** * Location of script source text. Can return null, in which case * this is assumed to be an inline script element. */virtual already_AddRefed<nsIURI> GetScriptURI() = 0;
/** * Script source text for inline script elements. */virtualvoidGetScriptText(nsAString& text) = 0;
virtualvoid GetScriptCharset(nsAString& charset) = 0;
void SetScriptLineNumber(PRUint32 aLineNumber)
{
mLineNumber = aLineNumber;
}
PRUint32 GetScriptLineNumber()
{
return mLineNumber;
}
void SetIsMalformed()
{
mMalformed = PR_TRUE;
}
PRBool IsMalformed()
{
return mMalformed;
}
void PreventExecution()
{
mIsEvaluated = PR_TRUE;
}
void WillCallDoneAddingChildren()
{
NS_ASSERTION(mDoneAddingChildren, "unexpected, but not fatal");
mDoneAddingChildren = PR_FALSE;
}
protected:
PRUint32 mLineNumber;
PRPackedBool mIsEvaluated;
PRPackedBool mMalformed;
PRPackedBool mDoneAddingChildren;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptElement, NS_ISCRIPTELEMENT_IID)
#endif // nsIScriptElement_h___