Code:
/ Dotnetfx_Win7_3.5.1 / Dotnetfx_Win7_3.5.1 / 3.5.1 / DEVDIV / depot / DevDiv / releases / Orcas / NetFXw7 / wpf / src / Framework / MS / Internal / IO / Packaging / ManagedFilter.cs / 1 / ManagedFilter.cs
//------------------------------------------------------------------------------
//
//
// Copyright (C) Microsoft Corporation. All rights reserved.
//
//
// Description:
// Managed equivalent of IFilter implementation
// Defines base class and helper class for interop
//
// History:
// 02/02/2004: BruceMac: Initial implementation.
// 02/17/2004: JohnLarc: Content of ManagedFilterMarshalingHelper now in IndexingFilterMarshaler.cs.
// 08/26/2004: JohnLarc: Removed access to indexing filters from managed code.
// 07/18/2005: ArindamB: Removed ManagedFilterBase and added IManagedFilter.
//
//-----------------------------------------------------------------------------
using System.Diagnostics;
using System;
using System.Windows; // for ExceptionStringTable
using System.IO; // for FileAccess
using System.Runtime.InteropServices;
using System.Collections;
using System.Security; // for SecurityCritical
using MS.Internal.Interop; // for CHUNK_BREAKTYPE, etc.
using MS.Internal; // for Invariant
using MS.Win32; // for NativeMethods
using MS.Internal.PresentationFramework; // SecurityHelper
// Not using the whole of System.Runtime.InteropServices.ComTypes so as to avoid collisions.
using IPersistFile = System.Runtime.InteropServices.ComTypes.IPersistFile;
namespace MS.Internal.IO.Packaging
{
#region Managed Struct Equivalents
///
/// Managed equivalent of a PROPSPEC
///
internal class ManagedPropSpec
{
///
/// Property Type (int or string)
///
///
/// Property name (only valid if PropType is Name
///
///
/// Property Id (only valid if PropType is Id)
///
///
/// Create a int-type PropSpec
///
///
internal ManagedPropSpec(uint id)
{
// Assign to a property rather than a field to ensure consistency through side-effects.
PropId = id;
}
///
/// Create a ManagedPropSpec from an unmanaged one
///
///
/// Critical - This code could be used to attempt to build a string from arbitrary data.
/// TreatAsSafe - There is a demand in this code. This code is not intended to be called from PT code.
/// Not designed to be exposed to public surface at all. Invoked (indirectly) by unmanaged client code.
///
[SecurityCritical, SecurityTreatAsSafe]
internal ManagedPropSpec(PROPSPEC propSpec)
{
SecurityHelper.DemandUnmanagedCode();
// Assign to properties rather than fields to ensure consistency through side-effects.
switch ((PropSpecType)propSpec.propType)
{
case PropSpecType.Id:
{
PropId = propSpec.union.propId;
break;
}
case PropSpecType.Name:
{
PropName = Marshal.PtrToStringUni(propSpec.union.name);
break;
}
default:
throw new ArgumentException(SR.Get(SRID.FilterPropSpecUnknownUnionSelector), "propSpec");
}
}
///
/// Private properties
///
private PropSpecType _propType;
private uint _id; // valid if we are an ID property type
private string _name; // valid if we are a Name property type
}
///
/// ManagedFullPropSpec
///
internal class ManagedFullPropSpec
{
///
/// Guid
///
///
/// Property
///
///
/// constructor
///
///
///
internal ManagedFullPropSpec(Guid guid, uint propId)
{
_guid = guid;
_property = new ManagedPropSpec(propId);
}
// If the following is not used once metadata filtering is implemented, remove completely from the code.
#if false
///
/// Helper constructor
///
/// property guid
///
internal ManagedFullPropSpec(Guid guid, string propName)
{
_guid = guid;
_property = new ManagedPropSpec(propName);
}
#endif
///
/// Handles native FULLPROPSPEC and does marshaling
///
///
internal ManagedFullPropSpec(FULLPROPSPEC nativePropSpec)
{
_guid = nativePropSpec.guid;
_property = new ManagedPropSpec(nativePropSpec.property);
}
private Guid _guid;
private ManagedPropSpec _property;
}
///
/// A descriptor for a chunk
///
internal class ManagedChunk
{
#region Constructors
///Build a contents chunk, passing the contents string.
/// id
/// The opening break for the chunk.
/// attribute
/// The locale ID for the chunk.
/// Indicates if it is text or value chunk.
///
/// All the chunks returned by the XAML filter and the container filter are text chunks.
/// Should a future filter implementation be capable of returning value chunks, a new constructor
/// and a Flags property will have to be defined.
///
internal ManagedChunk(uint index, CHUNK_BREAKTYPE breakType, ManagedFullPropSpec attribute, uint lcid, CHUNKSTATE flags)
{
// Argument errors can only be due to internal inconsistencies, since no input data makes its way here.
Invariant.Assert(breakType >= CHUNK_BREAKTYPE.CHUNK_NO_BREAK && breakType <= CHUNK_BREAKTYPE.CHUNK_EOC);
Invariant.Assert(attribute != null);
// Note that lcid values potentially cover the full range of uint values
// (see http://msdn.microsoft.com/library/default.asp?url=/library/en-us/intl/nls_8sj7.asp)
// and so no useful validation can be made for lcid.
_index = index;
_breakType = breakType;
_lcid = lcid;
_attribute = attribute;
_flags = flags;
// Since pseudo-properties (a.k.a. internal values) are not supported by the XPS filters,
// all chunks we return are expected to have idChunkSource equal to idChunk.
// (See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/indexsrv/html/ixufilt_8ib8.asp)
_idChunkSource = _index;
}
#endregion Constructors
#region Properties
internal uint ID
{
get
{
return _index;
}
set
{
_index = value;
}
}
///
/// Flags
///
/// Always null, since no named property is supported by the Indexing Services in Longhorn.
internal string PropertyName
{
get
{
return null;
}
}
#endif
///Indicates the type of break that precedes the chunk.
internal CHUNK_BREAKTYPE BreakType
{
get
{
return _breakType;
}
set
{
// Argument errors can only be due to internal inconsistencies,
// since no input data makes its way here.
Invariant.Assert(value >= CHUNK_BREAKTYPE.CHUNK_NO_BREAK
&& value <= CHUNK_BREAKTYPE.CHUNK_EOC);
_breakType = value;
}
}
///Indicates the locale the chunk belongs to.
internal uint Locale
{
get
{
return _lcid;
}
set
{
_lcid = value;
}
}
internal uint ChunkSource
{
get
{
return _idChunkSource;
}
}
internal uint StartSource
{
get
{
return _startSource;
}
}
internal uint LenSource
{
get
{
return _lenSource;
}
}
internal ManagedFullPropSpec Attribute
{
get
{
return _attribute;
}
set
{
_attribute = value;
}
}
#endregion Properties
#region Private Fields
private uint _index; // chunk id
private CHUNK_BREAKTYPE _breakType;
private CHUNKSTATE _flags;
private uint _lcid;
private ManagedFullPropSpec _attribute;
private uint _idChunkSource;
private uint _startSource = 0;
private uint _lenSource = 0;
#endregion Private Fields
}
#endregion Managed Struct Equivalents
#region IManagedFilter
///
/// Interface for managed implementations of IFilter handlers
///
interface IManagedFilter
{
///
/// Init
///
/// Usage flags. See IFilter spec for details.
///
/// Array of Managed FULLPROPSPEC structs to restrict responses.
/// May be null.
/// flags
IFILTER_FLAGS Init(
IFILTER_INIT grfFlags,
ManagedFullPropSpec[] aAttributes); // restrict responses to the specified attributes
///
/// GetChunk
///
///
/// The next managed chunk if it exists, null otherwise.
/// For valid chunk, ID of returned chunk should be greater than zero.
///
///
/// This should not throw exception to indicate end of chunks, and should
/// return null instead.
///
/// This is to avoid the perf hit of throwing an exception even for cases
/// in which it doesn't get propagated to the unmanaged IFilter client.
///
/// Specifically, when this ManagedFilter is for a content part in a package,
/// PackageFilter moves to the next part when the current part has no more
/// chunks, and in this case no need for an exception to be thrown
/// to indicate FILTER_E_END_OF_CHUNKS.
///
ManagedChunk GetChunk();
///
/// GetText
///
///
/// maximum number of Unicode characters to return in the String
/// string associated with the last returned Chunk
String GetText(int bufferCharacterCount);
///
/// GetValue
///
/// Only supports string types at this time
/// property associated with the last returned Chunk
Object GetValue();
}
#endregion IManagedFilter
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
//------------------------------------------------------------------------------
//
//
// Copyright (C) Microsoft Corporation. All rights reserved.
//
//
// Description:
// Managed equivalent of IFilter implementation
// Defines base class and helper class for interop
//
// History:
// 02/02/2004: BruceMac: Initial implementation.
// 02/17/2004: JohnLarc: Content of ManagedFilterMarshalingHelper now in IndexingFilterMarshaler.cs.
// 08/26/2004: JohnLarc: Removed access to indexing filters from managed code.
// 07/18/2005: ArindamB: Removed ManagedFilterBase and added IManagedFilter.
//
//-----------------------------------------------------------------------------
using System.Diagnostics;
using System;
using System.Windows; // for ExceptionStringTable
using System.IO; // for FileAccess
using System.Runtime.InteropServices;
using System.Collections;
using System.Security; // for SecurityCritical
using MS.Internal.Interop; // for CHUNK_BREAKTYPE, etc.
using MS.Internal; // for Invariant
using MS.Win32; // for NativeMethods
using MS.Internal.PresentationFramework; // SecurityHelper
// Not using the whole of System.Runtime.InteropServices.ComTypes so as to avoid collisions.
using IPersistFile = System.Runtime.InteropServices.ComTypes.IPersistFile;
namespace MS.Internal.IO.Packaging
{
#region Managed Struct Equivalents
///
/// Managed equivalent of a PROPSPEC
///
internal class ManagedPropSpec
{
///
/// Property Type (int or string)
///
///
/// Property name (only valid if PropType is Name
///
///
/// Property Id (only valid if PropType is Id)
///
///
/// Create a int-type PropSpec
///
///
internal ManagedPropSpec(uint id)
{
// Assign to a property rather than a field to ensure consistency through side-effects.
PropId = id;
}
///
/// Create a ManagedPropSpec from an unmanaged one
///
///
/// Critical - This code could be used to attempt to build a string from arbitrary data.
/// TreatAsSafe - There is a demand in this code. This code is not intended to be called from PT code.
/// Not designed to be exposed to public surface at all. Invoked (indirectly) by unmanaged client code.
///
[SecurityCritical, SecurityTreatAsSafe]
internal ManagedPropSpec(PROPSPEC propSpec)
{
SecurityHelper.DemandUnmanagedCode();
// Assign to properties rather than fields to ensure consistency through side-effects.
switch ((PropSpecType)propSpec.propType)
{
case PropSpecType.Id:
{
PropId = propSpec.union.propId;
break;
}
case PropSpecType.Name:
{
PropName = Marshal.PtrToStringUni(propSpec.union.name);
break;
}
default:
throw new ArgumentException(SR.Get(SRID.FilterPropSpecUnknownUnionSelector), "propSpec");
}
}
///
/// Private properties
///
private PropSpecType _propType;
private uint _id; // valid if we are an ID property type
private string _name; // valid if we are a Name property type
}
///
/// ManagedFullPropSpec
///
internal class ManagedFullPropSpec
{
///
/// Guid
///
///
/// Property
///
///
/// constructor
///
///
///
internal ManagedFullPropSpec(Guid guid, uint propId)
{
_guid = guid;
_property = new ManagedPropSpec(propId);
}
// If the following is not used once metadata filtering is implemented, remove completely from the code.
#if false
///
/// Helper constructor
///
/// property guid
///
internal ManagedFullPropSpec(Guid guid, string propName)
{
_guid = guid;
_property = new ManagedPropSpec(propName);
}
#endif
///
/// Handles native FULLPROPSPEC and does marshaling
///
///
internal ManagedFullPropSpec(FULLPROPSPEC nativePropSpec)
{
_guid = nativePropSpec.guid;
_property = new ManagedPropSpec(nativePropSpec.property);
}
private Guid _guid;
private ManagedPropSpec _property;
}
///
/// A descriptor for a chunk
///
internal class ManagedChunk
{
#region Constructors
///Build a contents chunk, passing the contents string.
/// id
/// The opening break for the chunk.
/// attribute
/// The locale ID for the chunk.
/// Indicates if it is text or value chunk.
///
/// All the chunks returned by the XAML filter and the container filter are text chunks.
/// Should a future filter implementation be capable of returning value chunks, a new constructor
/// and a Flags property will have to be defined.
///
internal ManagedChunk(uint index, CHUNK_BREAKTYPE breakType, ManagedFullPropSpec attribute, uint lcid, CHUNKSTATE flags)
{
// Argument errors can only be due to internal inconsistencies, since no input data makes its way here.
Invariant.Assert(breakType >= CHUNK_BREAKTYPE.CHUNK_NO_BREAK && breakType <= CHUNK_BREAKTYPE.CHUNK_EOC);
Invariant.Assert(attribute != null);
// Note that lcid values potentially cover the full range of uint values
// (see http://msdn.microsoft.com/library/default.asp?url=/library/en-us/intl/nls_8sj7.asp)
// and so no useful validation can be made for lcid.
_index = index;
_breakType = breakType;
_lcid = lcid;
_attribute = attribute;
_flags = flags;
// Since pseudo-properties (a.k.a. internal values) are not supported by the XPS filters,
// all chunks we return are expected to have idChunkSource equal to idChunk.
// (See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/indexsrv/html/ixufilt_8ib8.asp)
_idChunkSource = _index;
}
#endregion Constructors
#region Properties
internal uint ID
{
get
{
return _index;
}
set
{
_index = value;
}
}
///
/// Flags
///
/// Always null, since no named property is supported by the Indexing Services in Longhorn.
internal string PropertyName
{
get
{
return null;
}
}
#endif
///Indicates the type of break that precedes the chunk.
internal CHUNK_BREAKTYPE BreakType
{
get
{
return _breakType;
}
set
{
// Argument errors can only be due to internal inconsistencies,
// since no input data makes its way here.
Invariant.Assert(value >= CHUNK_BREAKTYPE.CHUNK_NO_BREAK
&& value <= CHUNK_BREAKTYPE.CHUNK_EOC);
_breakType = value;
}
}
///Indicates the locale the chunk belongs to.
internal uint Locale
{
get
{
return _lcid;
}
set
{
_lcid = value;
}
}
internal uint ChunkSource
{
get
{
return _idChunkSource;
}
}
internal uint StartSource
{
get
{
return _startSource;
}
}
internal uint LenSource
{
get
{
return _lenSource;
}
}
internal ManagedFullPropSpec Attribute
{
get
{
return _attribute;
}
set
{
_attribute = value;
}
}
#endregion Properties
#region Private Fields
private uint _index; // chunk id
private CHUNK_BREAKTYPE _breakType;
private CHUNKSTATE _flags;
private uint _lcid;
private ManagedFullPropSpec _attribute;
private uint _idChunkSource;
private uint _startSource = 0;
private uint _lenSource = 0;
#endregion Private Fields
}
#endregion Managed Struct Equivalents
#region IManagedFilter
///
/// Interface for managed implementations of IFilter handlers
///
interface IManagedFilter
{
///
/// Init
///
/// Usage flags. See IFilter spec for details.
///
/// Array of Managed FULLPROPSPEC structs to restrict responses.
/// May be null.
/// flags
IFILTER_FLAGS Init(
IFILTER_INIT grfFlags,
ManagedFullPropSpec[] aAttributes); // restrict responses to the specified attributes
///
/// GetChunk
///
///
/// The next managed chunk if it exists, null otherwise.
/// For valid chunk, ID of returned chunk should be greater than zero.
///
///
/// This should not throw exception to indicate end of chunks, and should
/// return null instead.
///
/// This is to avoid the perf hit of throwing an exception even for cases
/// in which it doesn't get propagated to the unmanaged IFilter client.
///
/// Specifically, when this ManagedFilter is for a content part in a package,
/// PackageFilter moves to the next part when the current part has no more
/// chunks, and in this case no need for an exception to be thrown
/// to indicate FILTER_E_END_OF_CHUNKS.
///
ManagedChunk GetChunk();
///
/// GetText
///
///
/// maximum number of Unicode characters to return in the String
/// string associated with the last returned Chunk
String GetText(int bufferCharacterCount);
///
/// GetValue
///
/// Only supports string types at this time
/// property associated with the last returned Chunk
Object GetValue();
}
#endregion IManagedFilter
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- ConfigurationStrings.cs
- NetMsmqSecurityElement.cs
- DataGridViewHitTestInfo.cs
- VideoDrawing.cs
- UnmanagedBitmapWrapper.cs
- HandledEventArgs.cs
- SessionPageStatePersister.cs
- ModelItemExtensions.cs
- Setter.cs
- ConnectionPointGlyph.cs
- TraceLog.cs
- ADConnectionHelper.cs
- XamlSerializationHelper.cs
- InfoCardClaim.cs
- SimpleExpression.cs
- TCEAdapterGenerator.cs
- PrintEvent.cs
- AnnotationComponentChooser.cs
- ComplexLine.cs
- ServiceReference.cs
- SystemWebExtensionsSectionGroup.cs
- PreviewPageInfo.cs
- EdgeModeValidation.cs
- ReliableSessionBindingElement.cs
- Message.cs
- SoapException.cs
- TextViewSelectionProcessor.cs
- DragStartedEventArgs.cs
- XmlSchemaSimpleType.cs
- ParameterExpression.cs
- TypeSystemProvider.cs
- C14NUtil.cs
- MetadataSource.cs
- RuntimeConfigLKG.cs
- MissingMethodException.cs
- DelegateHelpers.Generated.cs
- BufferAllocator.cs
- LinkedResourceCollection.cs
- Bits.cs
- Subordinate.cs
- ConfigurationStrings.cs
- SkewTransform.cs
- ControlTemplate.cs
- TemplateField.cs
- ScalarOps.cs
- Utils.cs
- WindowsFormsSynchronizationContext.cs
- GroupedContextMenuStrip.cs
- LocalizationComments.cs
- DataSpaceManager.cs
- MenuStrip.cs
- ChannelManagerBase.cs
- TabItemWrapperAutomationPeer.cs
- BitmapDownload.cs
- ZoneLinkButton.cs
- TextParentUndoUnit.cs
- ReadOnlyDataSource.cs
- DataGridGeneralPage.cs
- mediapermission.cs
- OutputScopeManager.cs
- TempEnvironment.cs
- CodeDirectoryCompiler.cs
- WhileDesigner.cs
- SplitContainerDesigner.cs
- PageSetupDialog.cs
- UrlParameterWriter.cs
- XmlSchemaCompilationSettings.cs
- DataColumnCollection.cs
- GenericsInstances.cs
- PeerResolverSettings.cs
- Int16.cs
- Bits.cs
- CombinedGeometry.cs
- ProjectionPruner.cs
- RuleProcessor.cs
- QilTernary.cs
- OrderedDictionary.cs
- AtomicFile.cs
- CallTemplateAction.cs
- NotCondition.cs
- HttpContext.cs
- ISO2022Encoding.cs
- NegatedConstant.cs
- RuntimeIdentifierPropertyAttribute.cs
- XsdDuration.cs
- UpdateExpressionVisitor.cs
- RevocationPoint.cs
- SerTrace.cs
- IIS7UserPrincipal.cs
- PreloadedPackages.cs
- HttpAsyncResult.cs
- SymbolEqualComparer.cs
- Mouse.cs
- ExtenderProvidedPropertyAttribute.cs
- httpstaticobjectscollection.cs
- PassportPrincipal.cs
- PartialList.cs
- SendKeys.cs
- NamespaceCollection.cs
- SchemaImporterExtensionElementCollection.cs