Opentk/Source/Bind/CppSpecWriter.cs
the_fiddler d6484bd630 * CppSpecWriter.cs: Renamed output files to gldef++.
Added preprocessor macros for enum generation.
2010-12-06 00:46:23 +00:00

462 lines
17 KiB
C#

#region License
//
// The Open Toolkit Library License
//
// Copyright (c) 2006 - 2010 the Open Toolkit library.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do
// so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
#endregion
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using Bind.Structures;
namespace Bind
{
using Delegate = Bind.Structures.Delegate;
using Enum = Bind.Structures.Enum;
using Type = Bind.Structures.Type;
sealed class CppSpecWriter : ISpecWriter
{
readonly char[] numbers = "0123456789".ToCharArray();
const string AllowDeprecated = "ALLOW_DEPRECATED_GL";
#region WriteBindings
public void WriteBindings(IBind generator)
{
WriteBindings(generator.Delegates, generator.Wrappers, generator.Enums);
}
void WriteBindings(DelegateCollection delegates, FunctionCollection wrappers, EnumCollection enums)
{
Console.WriteLine("Writing bindings to {0}", Settings.OutputPath);
if (!Directory.Exists(Settings.OutputPath))
Directory.CreateDirectory(Settings.OutputPath);
// Hack: Fix 3dfx extension category so it doesn't start with a digit
if (wrappers.ContainsKey("3dfx"))
{
var three_dee_fx = wrappers["3dfx"];
wrappers.Remove("3dfx");
wrappers.Add("T3dfx", three_dee_fx);
}
Settings.DefaultOutputNamespace = "OpenTK";
string temp_header_file = Path.GetTempFileName();
string temp_cpp_file = Path.GetTempFileName();
using (BindStreamWriter sw = new BindStreamWriter(temp_header_file))
{
WriteLicense(sw);
sw.WriteLine("namespace {0}", Settings.OutputNamespace);
sw.WriteLine("{");
sw.Indent();
WriteEnums(sw, enums);
sw.WriteLine("struct {0}", Settings.GLClass);
sw.WriteLine("{");
sw.Indent();
WriteWrappers(sw, wrappers, Type.CSTypes);
sw.Unindent();
sw.WriteLine("};");
sw.Unindent();
sw.WriteLine("}");
}
using (BindStreamWriter sw = new BindStreamWriter(temp_cpp_file))
{
WriteLicense(sw);
sw.WriteLine("namespace {0}", Settings.OutputNamespace);
sw.WriteLine("{");
sw.Indent();
WriteLoader(sw, wrappers, Type.CSTypes);
sw.Unindent();
sw.WriteLine("}");
}
string output_header = Path.Combine(Settings.OutputPath, "gldef++.h");
string output_cpp = Path.Combine(Settings.OutputPath, "gldef++.cpp");
if (File.Exists(output_header))
File.Delete(output_header);
File.Move(temp_header_file, output_header);
if (File.Exists(output_cpp))
File.Delete(output_cpp);
File.Move(temp_cpp_file, output_cpp);
}
#endregion
#region WriteLoader
void WriteLoader(BindStreamWriter sw, FunctionCollection wrappers,
Dictionary<string, string> CSTypes)
{
// Used to avoid multiple declarations of the same function
Delegate last_delegate = null;
// Declare all functions
foreach (var ext in wrappers.Keys)
{
var forward_compatible = wrappers[ext].Where(f => !f.Deprecated);
var deprecated = wrappers[ext].Where(f => f.Deprecated);
last_delegate = null;
foreach (var current in new IEnumerable<Function>[] { forward_compatible, deprecated })
{
if (current == deprecated)
{
sw.WriteLine("#ifdef {0}", AllowDeprecated);
sw.Indent();
}
foreach (var function in current)
{
if (function.WrappedDelegate == last_delegate)
continue;
last_delegate = function.WrappedDelegate;
if (ext == "Core")
sw.WriteLine("{0}::Delegates::p{1} {0}::Delegates::{1} = 0;", Settings.GLClass, function.Name);
else
sw.WriteLine("{0}::{1}::Delegates::p{2} {0}::{1}::Delegates::{2} = 0;", Settings.GLClass,
function.Extension, function.Name);
}
if (current == deprecated)
{
sw.Unindent();
sw.WriteLine("#endif");
}
}
}
sw.WriteLine();
// Add Init() methods
foreach (var ext in wrappers.Keys)
{
string path = null;
if (ext == "Core")
path = Settings.GLClass;
else
path = String.Format("{0}::{1}", Settings.GLClass, ext);
sw.WriteLine("void {0}::Init()", path);
sw.WriteLine("{");
sw.Indent();
var forward_compatible = wrappers[ext].Where(f => !f.Deprecated);
var deprecated = wrappers[ext].Where(f => f.Deprecated);
foreach (var current in new IEnumerable<Function>[] { forward_compatible, deprecated })
{
if (current == deprecated)
{
sw.WriteLine("#ifdef {0}", AllowDeprecated);
sw.Indent();
}
last_delegate = null;
foreach (var function in wrappers[ext])
{
if (function.WrappedDelegate == last_delegate)
continue;
last_delegate = function.WrappedDelegate;
sw.WriteLine("{0}::Delegates::{1} = ({0}::Delegates::p{1})GetAddress(\"gl{1}\");",
path, function.WrappedDelegate.Name);
}
if (current == deprecated)
{
sw.Unindent();
sw.WriteLine("#endif");
}
}
sw.Unindent();
sw.WriteLine("}");
}
}
#endregion
#region WriteDelegates
public void WriteDelegates(BindStreamWriter sw, DelegateCollection delegates)
{
throw new NotSupportedException();
}
static void WriteDelegate(BindStreamWriter sw, Delegate d, ref Delegate last_delegate)
{
// Avoid multiple definitions of the same function
if (d != last_delegate)
{
last_delegate = d;
var parameters = d.Parameters.ToString()
.Replace("String[]", "String*")
.Replace("[OutAttribute]", String.Empty);
sw.WriteLine("typedef {0} (*p{1}){2};", d.ReturnType, d.Name, parameters);
sw.WriteLine("static p{0} {0};", d.Name);
}
}
#endregion
#region WriteImports
public void WriteImports(BindStreamWriter sw, DelegateCollection delegates)
{
throw new NotSupportedException();
}
#endregion
#region WriteWrappers
public void WriteWrappers(BindStreamWriter sw, FunctionCollection wrappers,
Dictionary<string, string> CSTypes)
{
foreach (string extension in wrappers.Keys)
{
if (extension != "Core")
{
sw.WriteLine("struct {0}", extension);
sw.WriteLine("{");
sw.Indent();
}
// Avoid multiple definitions of the same function
Delegate last_delegate = null;
// Write forward-compatible functions
var forward_compatible = wrappers[extension].Where(f => !f.Deprecated);
var deprecated = wrappers[extension].Where(f => f.Deprecated);
// Write delegates
sw.WriteLine("private:");
sw.WriteLine("struct Delegates");
sw.WriteLine("{");
sw.Indent();
foreach (var current in new IEnumerable<Function>[] { forward_compatible, deprecated })
{
if (current == deprecated)
{
sw.WriteLine("#ifdef {0}", AllowDeprecated);
sw.Indent();
}
last_delegate = null;
foreach (var f in current)
{
WriteDelegate(sw, f.WrappedDelegate, ref last_delegate);
}
if (current == deprecated)
{
sw.Unindent();
sw.WriteLine("#endif");
}
}
sw.Unindent();
sw.WriteLine("};");
// Write wrappers
sw.WriteLine("public:");
sw.WriteLine("static void Init();");
foreach (var current in new IEnumerable<Function>[] { forward_compatible, deprecated })
{
if (current == deprecated)
{
sw.WriteLine("#ifdef {0}", AllowDeprecated);
sw.Indent();
}
last_delegate = null;
foreach (var f in current)
{
if (last_delegate == f.WrappedDelegate)
continue;
last_delegate = f.WrappedDelegate;
var parameters = f.WrappedDelegate.Parameters.ToString()
.Replace("String[]", "String*")
.Replace("[OutAttribute]", String.Empty);
sw.WriteLine("static inline {0} {1}{2}", f.WrappedDelegate.ReturnType,
f.TrimmedName, parameters);
sw.WriteLine("{");
sw.Indent();
WriteMethodBody(sw, f);
sw.Unindent();
sw.WriteLine("}");
}
if (current == deprecated)
{
sw.Unindent();
sw.WriteLine("#endif");
}
}
if (extension != "Core")
{
sw.Unindent();
sw.WriteLine("};");
}
}
}
static void WriteMethodBody(BindStreamWriter sw, Function f)
{
var callstring = f.Parameters.CallString()
.Replace("String[]", "String*");
if (f.ReturnType != null && !f.ReturnType.ToString().ToLower().Contains("void"))
sw.WriteLine("return Delegates::{0}{1};", f.WrappedDelegate.Name, callstring);
else
sw.WriteLine("Delegates::{0}{1};", f.WrappedDelegate.Name, callstring);
}
static DocProcessor processor = new DocProcessor(Path.Combine(Settings.DocPath, Settings.DocFile));
static Dictionary<string, string> docfiles;
void WriteDocumentation(BindStreamWriter sw, Function f)
{
if (docfiles == null)
{
docfiles = new Dictionary<string, string>();
foreach (string file in Directory.GetFiles(Settings.DocPath))
{
docfiles.Add(Path.GetFileName(file), file);
}
}
string docfile = null;
try
{
docfile = Settings.FunctionPrefix + f.WrappedDelegate.Name + ".xml";
if (!docfiles.ContainsKey(docfile))
docfile = Settings.FunctionPrefix + f.TrimmedName + ".xml";
if (!docfiles.ContainsKey(docfile))
docfile = Settings.FunctionPrefix + f.TrimmedName.TrimEnd(numbers) + ".xml";
string doc = null;
if (docfiles.ContainsKey(docfile))
{
doc = processor.ProcessFile(docfiles[docfile]);
}
if (doc == null)
{
doc = "/// <summary></summary>";
}
int summary_start = doc.IndexOf("<summary>") + "<summary>".Length;
string warning = "[deprecated: v{0}]";
string category = "[requires: {0}]";
if (f.Deprecated)
{
warning = String.Format(warning, f.DeprecatedVersion);
doc = doc.Insert(summary_start, warning);
}
if (f.Extension != "Core" && !String.IsNullOrEmpty(f.Category))
{
category = String.Format(category, f.Category);
doc = doc.Insert(summary_start, category);
}
else if (!String.IsNullOrEmpty(f.Version))
{
if (f.Category.StartsWith("VERSION"))
category = String.Format(category, "v" + f.Version);
else
category = String.Format(category, "v" + f.Version + " and " + f.Category);
doc = doc.Insert(summary_start, category);
}
sw.WriteLine(doc);
}
catch (Exception e)
{
Console.WriteLine("[Warning] Error processing file {0}: {1}", docfile, e.ToString());
}
}
#endregion
#region WriteTypes
public void WriteTypes(BindStreamWriter sw, Dictionary<string, string> CSTypes)
{
sw.WriteLine();
foreach (string s in CSTypes.Keys)
{
sw.WriteLine("typedef {0} {1};", s, CSTypes[s]);
}
}
#endregion
#region WriteEnums
public void WriteEnums(BindStreamWriter sw, EnumCollection enums)
{
foreach (Enum @enum in enums.Values)
{
sw.WriteLine("ENUM({0})", @enum.Name);
sw.WriteLine("{");
sw.Indent();
foreach (var c in @enum.ConstantCollection.Values)
{
// C++ doesn't have the concept of "unchecked", so remove this.
if (!c.Unchecked)
sw.WriteLine("{0},", c);
else
sw.WriteLine("{0},", c.ToString().Replace("unchecked", String.Empty));
}
sw.Unindent();
sw.WriteLine("};");
sw.WriteLine("END_ENUM({0})", @enum.Name);
sw.WriteLine();
}
}
#endregion
#region WriteLicense
public void WriteLicense(BindStreamWriter sw)
{
sw.WriteLine(File.ReadAllText(Path.Combine(Settings.InputPath, Settings.LicenseFile)));
sw.WriteLine();
}
#endregion
}
}