/// <summary>
/// This creates a new build object that is a deep copy of the current
/// instance.
/// </summary>
/// <returns>
/// A new build object that is a deep copy of this instance.
/// </returns>
public override BuildConfiguration Clone()
{
ReferenceTocExcludeConfiguration options =
new ReferenceTocExcludeConfiguration(this);
return(options);
}
/// <summary>
/// Initializes a new instance of the <see cref="ReferenceEngineSettings"/> class
/// with the default parameters.
/// </summary>
public ReferenceEngineSettings()
: base("Sandcastle.References.ReferenceEngineSettings", BuildEngineType.Reference)
{
_webMvcSdkType = BuildSpecialSdkType.Null;
_rootContainer = false;
_embedScriptSharp = true;
_includeAllMembersTopic = true;
_includeInheritedOverloadTopics = true;
_refNamer = ReferenceNamer.Orcas;
_refNaming = ReferenceNamingMethod.Guid;
IBuildNamedList <BuildConfiguration> configurations = this.Configurations;
if (configurations != null)
{
// For the ReferenceVisitors...
ReferenceCommentConfiguration comments =
new ReferenceCommentConfiguration();
ReferenceSpellCheckConfiguration spellCheck =
new ReferenceSpellCheckConfiguration();
ReferenceVisibilityConfiguration documentVisibility =
new ReferenceVisibilityConfiguration();
ReferenceXPathConfiguration pathDocumentVisibility =
new ReferenceXPathConfiguration();
pathDocumentVisibility.Enabled = false;
// For the ReferenceTocVistors...
ReferenceTocExcludeConfiguration excludeToc =
new ReferenceTocExcludeConfiguration();
ReferenceTocLayoutConfiguration layoutToc =
new ReferenceTocLayoutConfiguration();
configurations.Add(comments);
configurations.Add(documentVisibility);
configurations.Add(pathDocumentVisibility);
configurations.Add(spellCheck);
configurations.Add(excludeToc);
configurations.Add(layoutToc);
}
IBuildNamedList <BuildComponentConfiguration> componentConfigurations
= this.ComponentConfigurations;
if (componentConfigurations != null)
{
ReferencePreTransConfiguration preTrans =
new ReferencePreTransConfiguration();
ReferenceMissingTagsConfiguration missingTags =
new ReferenceMissingTagsConfiguration();
ReferenceAutoDocConfiguration autoDocument =
new ReferenceAutoDocConfiguration();
ReferenceIntelliSenseConfiguration intelliSense =
new ReferenceIntelliSenseConfiguration();
ReferencePlatformsConfiguration platforms =
new ReferencePlatformsConfiguration();
ReferenceCloneConfiguration cloneDocument =
new ReferenceCloneConfiguration();
ReferencePostTransConfiguration postTrans =
new ReferencePostTransConfiguration();
ReferenceCodeConfiguration codeComponent =
new ReferenceCodeConfiguration();
ReferenceMathConfiguration mathComponent =
new ReferenceMathConfiguration();
ReferenceMediaConfiguration mediaComponent =
new ReferenceMediaConfiguration();
ReferenceLinkConfiguration linkComponent =
new ReferenceLinkConfiguration();
ReferenceSharedConfiguration sharedComponent =
new ReferenceSharedConfiguration();
componentConfigurations.Add(preTrans);
componentConfigurations.Add(autoDocument);
componentConfigurations.Add(missingTags);
componentConfigurations.Add(intelliSense);
componentConfigurations.Add(platforms);
componentConfigurations.Add(cloneDocument);
componentConfigurations.Add(postTrans);
componentConfigurations.Add(codeComponent);
componentConfigurations.Add(mathComponent);
componentConfigurations.Add(mediaComponent);
componentConfigurations.Add(linkComponent);
componentConfigurations.Add(sharedComponent);
}
}
public override void Initialize(BuildContext context, ReferenceGroup group)
{
base.Initialize(context, group);
if (!this.IsInitialized)
{
return;
}
_notApplicable = false;
context["$TocExcludedNamespaces"] = String.Empty;
if (_tocExclude == null)
{
ReferenceEngineSettings engineSettings = this.EngineSettings;
Debug.Assert(engineSettings != null);
if (engineSettings == null)
{
this.IsInitialized = false;
return;
}
_tocExclude = engineSettings.TocExclude;
Debug.Assert(_tocExclude != null);
if (_tocExclude == null)
{
this.IsInitialized = false;
return;
}
}
ReferenceGroupContext groupContext =
context.GroupContexts[group.Id] as ReferenceGroupContext;
if (groupContext == null)
{
throw new BuildException(
"The group context is not provided, and it is required by the build system.");
}
// We do not have to spell check embedded documents...
string embeddedText = groupContext["$IsEmbeddedGroup"];
if (!String.IsNullOrEmpty(embeddedText) &&
embeddedText.Equals(Boolean.TrueString, StringComparison.OrdinalIgnoreCase))
{
_notApplicable = true;
return;
}
IList <string> commentFiles = groupContext.CommentFiles;
if (commentFiles != null && commentFiles.Count != 0)
{
_listTocExcludes = new BuildList <string>();
for (int i = 0; i < commentFiles.Count; i++)
{
XPathDocument document = new XPathDocument(commentFiles[i]);
XPathNavigator documentNavigator = document.CreateNavigator();
XPathNodeIterator iterator = documentNavigator.Select(
"//member[.//tocexclude or .//excludetoc]/@name");
if (iterator != null && iterator.Count != 0)
{
foreach (XPathNavigator navigator in iterator)
{
_listTocExcludes.Add(navigator.Value);
}
}
}
if (_listTocExcludes.Count == 0)
{
this.IsInitialized = false;
return;
}
}
else
{
this.IsInitialized = false;
return;
}
}
public ReferenceTocExcludeVisitor(ReferenceTocExcludeConfiguration configuration)
: base(VisitorName, configuration)
{
_tocExclude = configuration;
}
/// <summary>
/// Initializes a new instance of the <see cref="ReferenceTocExcludeConfiguration"/> class
/// with parameters copied from the specified instance of the
/// <see cref="ReferenceTocExcludeConfiguration"/> class, a copy constructor.
/// </summary>
/// <param name="source">
/// An instance of the <see cref="ReferenceTocExcludeConfiguration"/> class from which the
/// initialization parameters or values will be copied.
/// </param>
/// <exception cref="ArgumentNullException">
/// If the parameter <paramref name="source"/> is <see langword="null"/>.
/// </exception>
public ReferenceTocExcludeConfiguration(ReferenceTocExcludeConfiguration source)
: base(source)
{
}
