// Copyright (c) Ivan Bondarev, Stanislav Mikhalkovich (for details please see \doc\copyright.txt) // This code is distributed under the GNU LGPL (for details please see \doc\license.txt) using System; using System.IO; using System.Collections; using System.Collections.Generic; using System.Xml; using System.Text; using PascalABCCompiler.SemanticTreeConverters; using PascalABCCompiler.TreeRealization; using PascalABCCompiler.TreeConverter; namespace PascalABCCompiler { public class DocXmlManager { private XmlWriter xtw; private CompilationUnit cu; private bool is_assembly; private string unit_name; public void SaveXml(CompilationUnit cu) { try { this.cu = cu; is_assembly = cu.SyntaxTree is SyntaxTree.program_module || Compiler.IsDll(cu.SyntaxTree); XmlWriterSettings settings = new XmlWriterSettings(); settings.Encoding = Encoding.UTF8; settings.Indent = true; xtw = XmlTextWriter.Create(Path.ChangeExtension(cu.UnitFileName, ".xml"), settings); unit_name = Path.GetFileNameWithoutExtension(cu.UnitFileName); xtw.WriteStartDocument(); xtw.WriteStartElement("doc"); if (is_assembly) { xtw.WriteStartElement("assembly"); xtw.WriteStartElement("name"); xtw.WriteString(Path.GetFileNameWithoutExtension(cu.UnitFileName)); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { xtw.WriteStartElement("unit"); xtw.WriteStartAttribute("name"); //xtw.WriteString((cu.SemanticTree as common_unit_node).unit_name); xtw.WriteString(Path.GetFileNameWithoutExtension(cu.UnitFileName)); xtw.WriteEndAttribute(); xtw.WriteString(cu.SemanticTree.documentation); xtw.WriteEndElement(); } SaveMembers(); xtw.WriteEndElement(); xtw.Flush(); } catch (Exception) { } try { if (xtw != null) xtw.Close(); } catch { } } private void SaveMembers() { common_unit_node cun = cu.SemanticTree as common_unit_node; xtw.WriteStartElement("members"); foreach(common_namespace_node cnn in cun.namespaces) { foreach (common_type_node ctn in cnn.types) SaveType(ctn); foreach (type_synonym ts in cnn.type_synonyms) SaveTypeSynonim(ts); foreach (common_namespace_function_node cnfn in cnn.functions) SaveFunction(cnfn); foreach (namespace_variable nv in cnn.variables) SaveVariable(nv); foreach (namespace_constant_definition ncd in cnn.constants) SaveConstant(ncd); } xtw.WriteEndElement(); } private void SaveType(common_type_node ctn) { if (!string.IsNullOrEmpty(ctn.documentation)) { if (!ctn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (is_assembly) xtw.WriteString("T:"+get_name(ctn)); else xtw.WriteString("T:"+ctn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(ctn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",ctn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } foreach (common_method_node cmn in ctn.methods) SaveMethod(cmn); foreach (common_property_node cmn in ctn.properties) SaveProperty(cmn); foreach (common_event ce in ctn.events) SaveEvent(ce); foreach (class_field cmn in ctn.fields) SaveField(cmn); foreach (class_constant_definition cmn in ctn.const_defs) SaveClassConstant(cmn); } private void SaveTypeSynonim(type_synonym ctn) { if (!string.IsNullOrEmpty(ctn.documentation)) { if (!ctn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); xtw.WriteString("T:"+ctn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(ctn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",ctn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private void SaveFunction(common_namespace_function_node cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); xtw.WriteString("M:"+(is_assembly?unit_name+"."+unit_name+".":"")+cfn.name+GetGenericFlag(cfn)+GetParameters(cfn)); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private void SaveEvent(common_event cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (is_assembly) xtw.WriteString("E:"+get_name(cfn.cont_type)+"."+cfn.name); else xtw.WriteString("E:"+cfn.cont_type.name+"."+cfn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private string GetGenericFlag(common_function_node cfn) { if (!cfn.is_generic_function) return ""; return "``"+cfn.get_generic_params_list().Count.ToString(); } private void SaveMethod(common_method_node cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (is_assembly) { if (!cfn.is_constructor) xtw.WriteString("M:"+get_name(cfn.cont_type)+"."+cfn.name+GetGenericFlag(cfn)+GetParameters(cfn)); else xtw.WriteString("M:"+get_name(cfn.cont_type)+".#ctor"+GetGenericFlag(cfn)+GetParameters(cfn)); } else { if (!cfn.is_constructor) xtw.WriteString("M:"+cfn.cont_type.name+"."+cfn.name+GetGenericFlag(cfn)+GetParameters(cfn)); else xtw.WriteString("M:"+cfn.cont_type.name+".#ctor"+GetGenericFlag(cfn)+GetParameters(cfn)); } xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string descr = null; if (is_assembly) { if (!cfn.is_constructor) descr = "M:"+get_name(cfn.cont_type)+"."+cfn.name+GetGenericFlag(cfn)+GetParameters(cfn); else descr = "M:"+get_name(cfn.cont_type)+".#ctor"+GetGenericFlag(cfn)+GetParameters(cfn); } else { if (!cfn.is_constructor) descr = "M:"+cfn.cont_type.name+"."+cfn.name+GetGenericFlag(cfn)+GetParameters(cfn); else descr = "M:"+cfn.cont_type.name+".#ctor"+GetGenericFlag(cfn)+GetParameters(cfn); } string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private string GetParameters(common_function_node cfn) { StringBuilder sb = new StringBuilder(); if (cfn.parameters.Count > 0) { sb.Append("("); for (int i=0; i 0) { sb.Append("{"); for (int i=0; i 0) { sb.Append('('); for (int i=0; i")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (is_assembly) xtw.WriteString("P:"+get_name(cfn.comprehensive_type)+"."+cfn.name); else xtw.WriteString("P:"+cfn.comprehensive_type.name+"."+cfn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private void SaveField(class_field cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (is_assembly) xtw.WriteString("F:"+get_name(cfn.cont_type)+"."+cfn.name); else xtw.WriteString("F:"+cfn.cont_type.name+"."+cfn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private void SaveClassConstant(class_constant_definition cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (is_assembly) xtw.WriteString("F:"+get_name(cfn.comperehensive_type)+"."+cfn.name); else xtw.WriteString("F:"+cfn.comperehensive_type.name+"."+cfn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private void SaveConstant(namespace_constant_definition cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); xtw.WriteString((is_assembly?"F:"+unit_name+"."+unit_name+".":"C:")+cfn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } private void SaveVariable(var_definition_node cfn) { if (!string.IsNullOrEmpty(cfn.documentation)) { if (!cfn.documentation.Trim(' ','\t').StartsWith("")) { xtw.WriteStartElement("member"); xtw.WriteStartAttribute("name"); if (!is_assembly) xtw.WriteString("V:"+cfn.name); else xtw.WriteString("F:"+unit_name+"."+unit_name+"."+cfn.name); xtw.WriteEndAttribute(); xtw.WriteStartElement("summary"); xtw.WriteString(cfn.documentation); xtw.WriteEndElement(); xtw.WriteEndElement(); } else { string doc = string.Concat("",cfn.documentation,""); StringReader sr = new StringReader(doc); XmlReader xr = XmlTextReader.Create(sr); xr.Read(); xtw.WriteNode(xr.ReadSubtree(),false); sr.Close(); xr.Close(); } } } } }