Public Types | Public Member Functions | Public Attributes

jsdIFilter Interface Reference

Object representing a pattern of global object and/or url the debugger should ignore. More...

import "jsdIDebuggerService.idl";

List of all members.

Public Types

enum  { FLAG_RESERVED_MASK = 255U }
 

Object representing a pattern of global object and/or url the debugger should ignore.

More...
enum  { FLAG_ENABLED = 1U }
 

Filters without this flag set are ignored.

More...
enum  { FLAG_PASS = 2U }
 

Filters with this flag set are "pass" filters, they allow matching hooks to continue.

More...

Public Member Functions

virtual nsresult GetFlags (PRUint32 *aFlags)=0
 FLAG_* values from above, OR'd together.
virtual nsresult SetFlags (PRUint32 aFlags)=0
virtual nsresult GetGlobalObject (nsISupports **aGlobalObject)=0
 An nsISupports version of the global object to be filtered.
virtual nsresult SetGlobalObject (nsISupports *aGlobalObject)=0
virtual nsresult GetUrlPattern (nsACString &aUrlPattern)=0
 String representing the url pattern to be filtered.
virtual nsresult SetUrlPattern (const nsACString &aUrlPattern)=0
virtual nsresult GetStartLine (PRUint32 *aStartLine)=0
 Line number for the start of this filter.
virtual nsresult SetStartLine (PRUint32 aStartLine)=0
virtual nsresult GetEndLine (PRUint32 *aEndLine)=0
 Line number for the end of this filter.
virtual nsresult SetEndLine (PRUint32 aEndLine)=0

Public Attributes

const unsigned long FLAG_RESERVED_MASK = 0xFF
 These two bytes of the flags attribute are reserved for interpretation by the jsdService implementation.
const unsigned long FLAG_ENABLED = 0x01
 Filters without this flag set are ignored.
const unsigned long FLAG_PASS = 0x02
 Filters with this flag set are "pass" filters, they allow matching hooks to continue.
attribute unsigned long flags
 FLAG_* values from above, OR'd together.
attribute nsISupports globalObject
 An nsISupports version of the global object to be filtered.
attribute AUTF8String urlPattern
 String representing the url pattern to be filtered.
attribute unsigned long startLine
 Line number for the start of this filter.
attribute unsigned long endLine
 Line number for the end of this filter.

Detailed Description

Object representing a pattern of global object and/or url the debugger should ignore.

The debugger service itself will not modify properties of these objects.


Member Enumeration Documentation

anonymous enum

Object representing a pattern of global object and/or url the debugger should ignore.

The debugger service itself will not modify properties of these objects. These two bytes of the flags attribute are reserved for interpretation by the jsdService implementation. You can do what you like with the remaining flags.

Enumerator:
FLAG_RESERVED_MASK 
anonymous enum

Filters without this flag set are ignored.

Enumerator:
FLAG_ENABLED 
anonymous enum

Filters with this flag set are "pass" filters, they allow matching hooks to continue.

Filters without this flag block matching hooks.

Enumerator:
FLAG_PASS 

Member Function Documentation

virtual nsresult jsdIFilter::GetEndLine ( PRUint32 *  aEndLine  )  [pure virtual]

Line number for the end of this filter.

Line numbers are one based. Assigning a 0 to this attribute will tell the debugger to ignore from |startLine| to the end of the file.

virtual nsresult jsdIFilter::GetFlags ( PRUint32 *  aFlags  )  [pure virtual]

FLAG_* values from above, OR'd together.

virtual nsresult jsdIFilter::GetGlobalObject ( nsISupports **  aGlobalObject  )  [pure virtual]

An nsISupports version of the global object to be filtered.

A null glob matches all hooks. This attribute must be QI'able to the (non-scriptable) nsIScriptGlobalObject interface.

The jsdIService caches this value internally, so if it changes you must swap the filter with itself using jsdIService::swapFilters.

virtual nsresult jsdIFilter::GetStartLine ( PRUint32 *  aStartLine  )  [pure virtual]

Line number for the start of this filter.

Line numbers are one based. Assigning a 0 to this attribute will tell the debugger to ignore the entire file.

virtual nsresult jsdIFilter::GetUrlPattern ( nsACString aUrlPattern  )  [pure virtual]

String representing the url pattern to be filtered.

Supports limited glob matching, at the beginning and end of the pattern only. For example, "chrome://venkman*" filters all urls that start with chrome/venkman, "*.cgi" filters all cgi's, and "http://myserver/utils.js" filters only the utils.js file on "myserver". A null urlPattern matches all urls.

The jsdIService caches this value internally, to if it changes you must swap the filter with itself using jsdIService::swapFilters.

virtual nsresult jsdIFilter::SetEndLine ( PRUint32  aEndLine  )  [pure virtual]
virtual nsresult jsdIFilter::SetFlags ( PRUint32  aFlags  )  [pure virtual]
virtual nsresult jsdIFilter::SetGlobalObject ( nsISupports aGlobalObject  )  [pure virtual]
virtual nsresult jsdIFilter::SetStartLine ( PRUint32  aStartLine  )  [pure virtual]
virtual nsresult jsdIFilter::SetUrlPattern ( const nsACString aUrlPattern  )  [pure virtual]

Member Data Documentation

attribute unsigned long jsdIFilter::endLine

Line number for the end of this filter.

Line numbers are one based. Assigning a 0 to this attribute will tell the debugger to ignore from |startLine| to the end of the file.

const unsigned long jsdIFilter::FLAG_ENABLED = 0x01

Filters without this flag set are ignored.

const unsigned long jsdIFilter::FLAG_PASS = 0x02

Filters with this flag set are "pass" filters, they allow matching hooks to continue.

Filters without this flag block matching hooks.

const unsigned long jsdIFilter::FLAG_RESERVED_MASK = 0xFF

These two bytes of the flags attribute are reserved for interpretation by the jsdService implementation.

You can do what you like with the remaining flags.

attribute unsigned long jsdIFilter::flags

FLAG_* values from above, OR'd together.

An nsISupports version of the global object to be filtered.

A null glob matches all hooks. This attribute must be QI'able to the (non-scriptable) nsIScriptGlobalObject interface.

The jsdIService caches this value internally, so if it changes you must swap the filter with itself using jsdIService::swapFilters.

attribute unsigned long jsdIFilter::startLine

Line number for the start of this filter.

Line numbers are one based. Assigning a 0 to this attribute will tell the debugger to ignore the entire file.

attribute AUTF8String jsdIFilter::urlPattern

String representing the url pattern to be filtered.

Supports limited glob matching, at the beginning and end of the pattern only. For example, "chrome://venkman*" filters all urls that start with chrome/venkman, "*.cgi" filters all cgi's, and "http://myserver/utils.js" filters only the utils.js file on "myserver". A null urlPattern matches all urls.

The jsdIService caches this value internally, to if it changes you must swap the filter with itself using jsdIService::swapFilters.


The documentation for this interface was generated from the following files: