// Strips MathML tags from the source and replaces the equations with the content
// found in the <!-- eqn: :--> comments in the docs.
// Todo: Some simple MathML tags do not include comments, find a solution.
// Todo: Some files include more than 1 function - find a way to map these extra functions.
Documentation ProcessFile(string file, EnumProcessor processor)
{
string text;
if (LastFile == file)
return Cached;
LastFile = file;
text = File.ReadAllText(file);
text = text
.Replace("ε", "epsilon") // Fix unrecognized ε entities
.Replace("xml:", String.Empty); // Remove namespaces
text = remove_doctype.Replace(text, String.Empty);
text = remove_xmlns.Replace(text, string.Empty);
Match m = remove_mathml.Match(text);
while (m.Length > 0)
{
string removed = text.Substring(m.Index, m.Length);
text = text.Remove(m.Index, m.Length);
int equation = removed.IndexOf("eqn");
if (equation > 0)
{
// Find the start and end of the equation string
int eqn_start = equation + 4;
int eqn_end = removed.IndexOf(":-->") - equation - 4;
if (eqn_end < 0)
{
// Note: a few docs from man4 delimit eqn end with ": -->"
eqn_end = removed.IndexOf(": -->") - equation - 4;
}
if (eqn_end < 0)
{
Console.WriteLine("[Warning] Failed to find equation for mml.");
goto next;
}
string eqn_substring = removed.Substring(eqn_start, eqn_end);
text = text.Insert(m.Index, "<![CDATA[" + eqn_substring + "]]>");
}
next:
m = remove_mathml.Match(text);
}
XDocument doc = null;
try
{
doc = XDocument.Parse(text);
Cached = ToInlineDocs(doc, processor);
return Cached;
}
catch (Exception e)
{
Console.WriteLine(e.ToString());
Console.WriteLine(doc.ToString());
return null;
}
}
Documentation ToInlineDocs(XDocument doc, EnumProcessor enum_processor)
{
if (doc == null || enum_processor == null)
throw new ArgumentNullException();
var no_const_processing = Settings.Legacy.NoAdvancedEnumProcessing | Settings.Legacy.ConstIntEnums;
if (!Generator.Settings.IsEnabled(no_const_processing))
{
// Translate all GL_FOO_BAR constants according to EnumProcessor
foreach (var e in doc.XPathSelectElements("//constant"))
{
var c = e.Value;
if (c.StartsWith(Settings.ConstantPrefix))
{
// Remove "GL_" from the beginning of the string
c = c.Replace(Settings.ConstantPrefix, String.Empty);
}
e.Value = enum_processor.TranslateConstantName(c, false);
}
}
// Create inline documentation
var inline = new Documentation
{
Summary =
Cleanup(
((IEnumerable)doc.XPathEvaluate("/refentry/refnamediv/refpurpose"))
.Cast<XElement>().First().Value),
Parameters =
((IEnumerable)doc.XPathEvaluate("/refentry/refsect1[@id='parameters']/variablelist/varlistentry/term/parameter"))
.Cast<XElement>()
.Select(p =>
new DocumentationParameter(
p.Value.Trim(),
Cleanup(p.XPathSelectElement("../../listitem").Value)))
.ToList()
};
inline.Summary = Char.ToUpper(inline.Summary[0]) + inline.Summary.Substring(1);
return inline;
}