public override void WritePage(UdnManifest Manifest, string OutputPath)
{
using (UdnWriter Writer = new UdnWriter(OutputPath))
{
Writer.WritePageHeader(Name, PageCrumbs, "");
List <APIMember> FilteredMembers = Members;
// Get the name of the withheld section
APIModule Module = FindParent <APIModule>();
if (Module != null)
{
string UnlistedEntries = Program.Settings.FindValue("Module." + Module.Name + ".Unlisted");
if (UnlistedEntries != null)
{
HashSet <APIPage> UnlistedPages = new HashSet <APIPage>(UnlistedEntries.Split('\n').Select(x => Manifest.Find(x.Trim())));
FilteredMembers = new List <APIMember>(FilteredMembers.Where(x => !UnlistedPages.Contains(x)));
}
}
// Find all the records, sorted by name
List <APIRecord> AllRecords = new List <APIRecord>(FilteredMembers.OfType <APIRecord>().Where(x => !x.bIsTemplateSpecialization).OrderBy(x => x.Name));
// Find all the functions, sorted by name
List <APIFunction> AllFunctions = new List <APIFunction>();
AllFunctions.AddRange(FilteredMembers.OfType <APIFunction>().Where(x => !x.bIsTemplateSpecialization));
AllFunctions.AddRange(FilteredMembers.OfType <APIFunctionGroup>().SelectMany(x => x.Children.OfType <APIFunction>()).Where(x => !x.bIsTemplateSpecialization));
AllFunctions.Sort((x, y) => (x.Name.CompareTo(y.Name)));
// Enter the module template
Writer.EnterTag("[OBJECT:Filter]");
// Write the class list
Writer.EnterTag("[PARAM:filters]");
APIFilter.WriteListSection(Writer, "filters", "Filters", Filters.OrderBy(x => x.Name));
Writer.LeaveTag("[/PARAM]");
// Write the class list
Writer.EnterTag("[PARAM:classes]");
Writer.WriteListSection("classes", "Classes", "Name", "Description", AllRecords.Select(x => x.GetListItem()));
Writer.LeaveTag("[/PARAM]");
// Write all the constants
Writer.EnterTag("[PARAM:constants]");
Writer.WriteListSection("constants", "Constants", "Name", "Description", FilteredMembers.OfType <APIConstant>().Select(x => x.GetListItem()));
Writer.LeaveTag("[/PARAM]");
// Write the typedef list
Writer.EnterTag("[PARAM:typedefs]");
Writer.WriteListSection("typedefs", "Typedefs", "Name", "Description", FilteredMembers.OfType <APITypeDef>().Select(x => x.GetListItem()));
Writer.LeaveTag("[/PARAM]");
// Write the enum list
Writer.EnterTag("[PARAM:enums]");
Writer.WriteListSection("enums", "Enums", "Name", "Description", FilteredMembers.OfType <APIEnum>().OrderBy(x => x.Name).Select(x => x.GetListItem()));
Writer.LeaveTag("[/PARAM]");
// Write the function list
Writer.EnterTag("[PARAM:functions]");
APIFunction.WriteListSection(Writer, "functions", "Functions", AllFunctions, true);
Writer.LeaveTag("[/PARAM]");
// Write the variable list
Writer.EnterTag("[PARAM:variables]");
APIVariable.WriteListSection(Writer, "variables", "Variables", FilteredMembers.OfType <APIVariable>());
Writer.LeaveTag("[/PARAM]");
// Close the module template
Writer.LeaveTag("[/OBJECT]");
}
}
public override void WritePage(UdnManifest Manifest, string OutputPath)
{
using (UdnWriter Writer = new UdnWriter(OutputPath))
{
Writer.WritePageHeader(Name, PageCrumbs, BriefDescription);
// Write the hierarchy
if (HierarchyNode != null)
{
Writer.EnterSection("hierarchy", "Inheritance Hierarchy");
Writer.EnterTag("[REGION:hierarchy]");
APIHierarchy.WriteHierarchy(Writer, HierarchyNode, "hrch");
Writer.LeaveTag("[/REGION]");
Writer.LeaveSection();
}
// Write the record definition
if (!Utility.IsNullOrWhitespace(Definition))
{
Writer.EnterSection("syntax", "Syntax");
WriteDefinition(Writer);
Writer.LeaveSection();
}
// Write the class description
if (!Utility.IsNullOrWhitespace(FullDescription))
{
Writer.EnterSection("description", "Remarks");
Writer.WriteLine(FullDescription.Replace("<", "<").Replace(">", ">"));
Writer.LeaveSection();
}
// Write the main body section
Writer.EnterRegion("syntax");
// Build a list of all the functions
List <APIFunction> AllFunctions = new List <APIFunction>();
AllFunctions.AddRange(Children.OfType <APIFunction>().Where(x => x.Protection != APIProtection.Private && !x.IsDeprecated()));
AllFunctions.AddRange(Children.OfType <APIFunctionGroup>().SelectMany(x => x.Children.OfType <APIFunction>()).Where(x => x.Protection != APIProtection.Private && !x.IsDeprecated()));
AllFunctions.Sort((x, y) => String.Compare(x.Name, y.Name));
// Write all the specializations
if (TemplateSpecializations.Count > 0)
{
Writer.EnterSection("specializations", "Specializations");
foreach (APIRecord Specialization in TemplateSpecializations)
{
Writer.WriteLine("[{0}]({1}) ", Specialization.Name, Specialization.LinkPath);
}
Writer.LeaveSection();
}
// Write all the variables
APIVariable.WriteListSection(Writer, "variables", "Variables", Children.OfType <APIVariable>().Where(x => x.Protection != APIProtection.Private && !x.IsDeprecated()).OrderBy(x => x.Name));
// Write all the constructors
if (!APIFunction.WriteListSection(Writer, "constructor", "Constructors", AllFunctions.Where(x => x.FunctionType == APIFunctionType.Constructor).OrderBy(x => x.LinkPath), false) && HasAnyPrivateFunction(Name))
{
Writer.EnterSection("constructor", "Constructors");
Writer.WriteLine("No constructors are accessible with public or protected access.");
Writer.LeaveSection();
}
// Write all the destructors
if (!APIFunction.WriteListSection(Writer, "destructor", "Destructors", AllFunctions.Where(x => x.FunctionType == APIFunctionType.Destructor), false) && HasAnyPrivateFunction("~" + Name))
{
Writer.EnterSection("destructors", "Destructors");
Writer.WriteLine("No destructors are accessible with public or protected access.");
Writer.LeaveSection();
}
// Find a list of base classes
List <APIRecord> AllBaseRecords = new List <APIRecord>();
FindAllBaseRecords(AllBaseRecords);
// Build a list of functions for each base record
List <APIFunction>[] AllBaseFunctions = AllBaseRecords.Select(x => new List <APIFunction>()).ToArray();
foreach (APIFunction Function in AllFunctions.Where(x => x.FunctionType == APIFunctionType.Normal && !x.IsExecFunction()))
{
int BaseRecordIdx = AllBaseRecords.IndexOf(Function.GetBaseImplementation().FindParent <APIRecord>());
AllBaseFunctions[Math.Max(0, BaseRecordIdx)].Add(Function);
}
// Write the functions
for (int Idx = 0; Idx < AllBaseFunctions.Length; Idx++)
{
List <APIFunction> BaseFunctions = AllBaseFunctions[Idx];
if (BaseFunctions.Count > 0)
{
string Id = String.Format("functions_{0}", Idx);
string Label = (Idx == 0) ? "Functions" : String.Format("Overridden from {0}", AllBaseRecords[Idx].Name);
APIFunction.WriteListSection(Writer, Id, Label, AllBaseFunctions[Idx], true);
}
}
// Write the operator list
APIFunction.WriteListSection(Writer, "operators", "Operators", AllFunctions.Where(x => x.FunctionType == APIFunctionType.UnaryOperator || x.FunctionType == APIFunctionType.BinaryOperator), true);
// Write all the inner structures
Writer.WriteListSection("classes", "Classes", "Name", "Description", Children.OfType <APIRecord>().Where(x => x.Protection != APIProtection.Private).OrderBy(x => x.Name).Select(x => x.GetListItem()));
// Write all the enums
Writer.WriteListSection("enums", "Enums", "Name", "Description", Children.OfType <APIEnum>().OrderBy(x => x.Name).Select(x => x.GetListItem()));
// Write all the typedefs
Writer.WriteListSection("typedefs", "Typedefs", "Name", "Description", Children.OfType <APITypeDef>().Select(x => x.GetListItem()));
// Write all the constants
Writer.WriteListSection("constants", "Constants", "Name", "Description", Children.OfType <APIConstant>().Select(x => x.GetListItem()));
// Leave the body
Writer.LeaveRegion();
// Write the marshalling parameters
if (DelegateEventParameters != null)
{
Writer.EnterSection("marshalling", "Marshalling");
Writer.WriteLine("Parameters are marshalled using [{0}]({1})", DelegateEventParameters.FullName, DelegateEventParameters.LinkPath);
Writer.LeaveSection();
}
// Write the @see directives
WriteSeeAlsoSection(Writer, SeeAlso);
// Write the references
WriteReferencesSection(Writer, Entity);
}
}
