//
// codegen.cs: The code generator
//
// Author:
// Miguel de Icaza (miguel@ximian.com)
//
// (C) 2001 Ximian, Inc.
//
using System;
using System.IO;
using System.Collections;
using System.Reflection;
using System.Reflection.Emit;
using System.Diagnostics.SymbolStore;
namespace Mono.CSharp {
///
/// Code generator class.
///
public class CodeGen {
static AppDomain current_domain;
public static AssemblyBuilder AssemblyBuilder;
public static ModuleBuilder ModuleBuilder;
static public ISymbolWriter SymbolWriter;
public static string Basename (string name)
{
int pos = name.LastIndexOf ("/");
if (pos != -1)
return name.Substring (pos + 1);
pos = name.LastIndexOf ("\\");
if (pos != -1)
return name.Substring (pos + 1);
return name;
}
public static string Dirname (string name)
{
int pos = name.LastIndexOf ("/");
if (pos != -1)
return name.Substring (0, pos);
pos = name.LastIndexOf ("\\");
if (pos != -1)
return name.Substring (0, pos);
return ".";
}
static string TrimExt (string name)
{
int pos = name.LastIndexOf (".");
return name.Substring (0, pos);
}
static public string FileName;
//
// This routine initializes the Mono runtime SymbolWriter.
//
static bool InitMonoSymbolWriter (string basename, string symbol_output,
string exe_output_file, string[] debug_args)
{
Type itype = SymbolWriter.GetType ();
if (itype == null)
return false;
Type[] arg_types = new Type [3];
arg_types [0] = typeof (string);
arg_types [1] = typeof (string);
arg_types [2] = typeof (string[]);
MethodInfo initialize = itype.GetMethod ("Initialize", arg_types);
if (initialize == null)
return false;
object[] args = new object [3];
args [0] = exe_output_file;
args [1] = symbol_output;
args [2] = debug_args;
initialize.Invoke (SymbolWriter, args);
return true;
}
//
// Initializes the symbol writer
//
static void InitializeSymbolWriter (string basename, string symbol_output,
string exe_output_file, string[] args)
{
SymbolWriter = ModuleBuilder.GetSymWriter ();
//
// If we got an ISymbolWriter instance, initialize it.
//
if (SymbolWriter == null) {
Report.Warning (
-18, "Cannot find any symbol writer");
return;
}
//
// Due to lacking documentation about the first argument of the
// Initialize method, we cannot use Microsoft's default symbol
// writer yet.
//
// If we're using the mono symbol writer, the SymbolWriter object
// is of type MonoSymbolWriter - but that's defined in a dynamically
// loaded DLL - that's why we're doing a comparision based on the type
// name here instead of using `SymbolWriter is MonoSymbolWriter'.
//
Type sym_type = ((object) SymbolWriter).GetType ();
switch (sym_type.Name){
case "MonoSymbolWriter":
if (!InitMonoSymbolWriter (basename, symbol_output,
exe_output_file, args))
Report.Warning (
-18, "Cannot initialize the symbol writer");
break;
default:
Report.Warning (
-18, "Cannot generate debugging information on this platform");
break;
}
}
//
// Initializes the code generator variables
//
static public void Init (string name, string output, bool want_debugging_support,
string[] debug_args)
{
AssemblyName an;
FileName = output;
an = new AssemblyName ();
an.Name = TrimExt (Basename (name));
current_domain = AppDomain.CurrentDomain;
AssemblyBuilder = current_domain.DefineDynamicAssembly (
an, AssemblyBuilderAccess.RunAndSave, Dirname (name));
//
// Pass a path-less name to DefineDynamicModule. Wonder how
// this copes with output in different directories then.
// FIXME: figure out how this copes with --output /tmp/blah
//
// If the third argument is true, the ModuleBuilder will dynamically
// load the default symbol writer.
//
ModuleBuilder = AssemblyBuilder.DefineDynamicModule (
Basename (name), Basename (output), want_debugging_support);
int pos = output.LastIndexOf (".");
string basename;
if (pos > 0)
basename = output.Substring (0, pos);
else
basename = output;
string symbol_output = basename + ".dbg";
if (want_debugging_support)
InitializeSymbolWriter (basename, symbol_output, output, debug_args);
else {
try {
File.Delete (symbol_output);
} catch {
// Ignore errors.
}
}
}
static public void Save (string name)
{
try {
AssemblyBuilder.Save (Basename (name));
} catch (System.IO.IOException io){
Report.Error (16, "Coult not write to file `"+name+"', cause: " + io.Message);
}
}
static public void SaveSymbols ()
{
if (SymbolWriter != null) {
// If we have a symbol writer, call its Close() method to write
// the symbol file to disk.
//
// When using Mono's default symbol writer, the Close() method must
// be called after the assembly has already been written to disk since
// it opens the assembly and reads its metadata.
SymbolWriter.Close ();
}
}
}
///
/// An Emit Context is created for each body of code (from methods,
/// properties bodies, indexer bodies or constructor bodies)
///
public class EmitContext {
public DeclSpace DeclSpace;
public TypeContainer TypeContainer;
public ILGenerator ig;
///
/// This variable tracks the `checked' state of the compilation,
/// it controls whether we should generate code that does overflow
/// checking, or if we generate code that ignores overflows.
///
/// The default setting comes from the command line option to generate
/// checked or unchecked code plus any source code changes using the
/// checked/unchecked statements or expressions. Contrast this with
/// the ConstantCheckState flag.
///
public bool CheckState;
///
/// The constant check state is always set to `true' and cant be changed
/// from the command line. The source code can change this setting with
/// the `checked' and `unchecked' statements and expressions.
///
public bool ConstantCheckState;
///
/// Whether we are emitting code inside a static or instance method
///
public bool IsStatic;
///
/// Whether we are emitting a field initializer
///
public bool IsFieldInitializer;
///
/// The value that is allowed to be returned or NULL if there is no
/// return type.
///
public Type ReturnType;
///
/// Points to the Type (extracted from the TypeContainer) that
/// declares this body of code
///
public Type ContainerType;
///
/// Whether this is generating code for a constructor
///
public bool IsConstructor;
///
/// Whether we're control flow analysis enabled
///
public bool DoFlowAnalysis;
///
/// Keeps track of the Type to LocalBuilder temporary storage created
/// to store structures (used to compute the address of the structure
/// value on structure method invocations)
///
public Hashtable temporary_storage;
public Block CurrentBlock;
///
/// The location where we store the return value.
///
LocalBuilder return_value;
///
/// The location where return has to jump to return the
/// value
///
public Label ReturnLabel;
///
/// If we already defined the ReturnLabel
///
public bool HasReturnLabel;
///
/// Whether we are in a Finally block
///
public bool InFinally;
///
/// Whether we are in a Try block
///
public bool InTry;
///
/// Whether we are in a Catch block
///
public bool InCatch;
///
/// Whether we are inside an unsafe block
///
public bool InUnsafe;
///
/// Whether we are inside an unsafe block
///
public bool InvokingOwnOverload;
///
/// Location for this EmitContext
///
public Location loc;
///
/// Used to flag that it is ok to define types recursively, as the
/// expressions are being evaluated as part of the type lookup
/// during the type resolution process
///
public bool ResolvingTypeTree;
///
/// Inside an enum definition, we do not resolve enumeration values
/// to their enumerations, but rather to the underlying type/value
/// This is so EnumVal + EnumValB can be evaluated.
///
/// There is no "E operator + (E x, E y)", so during an enum evaluation
/// we relax the rules
///
public bool InEnumContext;
public string BlockName;
protected Stack FlowStack;
public EmitContext (TypeContainer parent, DeclSpace ds, Location l, ILGenerator ig,
Type return_type, int code_flags, bool is_constructor)
{
this.ig = ig;
TypeContainer = parent;
DeclSpace = ds;
CheckState = RootContext.Checked;
ConstantCheckState = true;
IsStatic = (code_flags & Modifiers.STATIC) != 0;
ReturnType = return_type;
IsConstructor = is_constructor;
CurrentBlock = null;
BlockName = "";
InvokingOwnOverload = false;
if (parent != null){
// Can only be null for the ResolveType contexts.
ContainerType = parent.TypeBuilder;
if (parent.UnsafeContext)
InUnsafe = true;
else
InUnsafe = (code_flags & Modifiers.UNSAFE) != 0;
}
loc = l;
FlowStack = new Stack ();
if (ReturnType == TypeManager.void_type)
ReturnType = null;
}
public EmitContext (TypeContainer tc, Location l, ILGenerator ig,
Type return_type, int code_flags, bool is_constructor)
: this (tc, tc, l, ig, return_type, code_flags, is_constructor)
{
}
public EmitContext (TypeContainer tc, Location l, ILGenerator ig,
Type return_type, int code_flags)
: this (tc, tc, l, ig, return_type, code_flags, false)
{
}
public FlowBranching CurrentBranching {
get {
return (FlowBranching) FlowStack.Peek ();
}
}
//
// Starts a new code branching. This inherits the state of all local
// variables and parameters from the current branching.
//
public FlowBranching StartFlowBranching (FlowBranchingType type, Location loc)
{
FlowBranching cfb = new FlowBranching (CurrentBranching, type, null, loc);
FlowStack.Push (cfb);
return cfb;
}
//
// Starts a new code branching for block `block'.
//
public FlowBranching StartFlowBranching (Block block)
{
FlowBranching cfb;
FlowBranchingType type;
if (CurrentBranching.Type == FlowBranchingType.SWITCH)
type = FlowBranchingType.SWITCH_SECTION;
else
type = FlowBranchingType.BLOCK;
cfb = new FlowBranching (CurrentBranching, type, block, block.StartLocation);
FlowStack.Push (cfb);
return cfb;
}
//
// Ends a code branching. Merges the state of locals and parameters
// from all the children of the ending branching.
//
public FlowReturns EndFlowBranching ()
{
FlowBranching cfb = (FlowBranching) FlowStack.Pop ();
return CurrentBranching.MergeChild (cfb);
}
//
// Kills the current code branching. This throws away any changed state
// information and should only be used in case of an error.
//
public void KillFlowBranching ()
{
FlowBranching cfb = (FlowBranching) FlowStack.Pop ();
}
//
// Checks whether the local variable `vi' is already initialized
// at the current point of the method's control flow.
// If this method returns false, the caller must report an
// error 165.
//
public bool IsVariableAssigned (VariableInfo vi)
{
if (DoFlowAnalysis)
return CurrentBranching.IsVariableAssigned (vi);
else
return true;
}
//
// Marks the local variable `vi' as being initialized at the current
// current point of the method's control flow.
//
public void SetVariableAssigned (VariableInfo vi)
{
if (DoFlowAnalysis)
CurrentBranching.SetVariableAssigned (vi);
}
//
// Checks whether the parameter `number' is already initialized
// at the current point of the method's control flow.
// If this method returns false, the caller must report an
// error 165. This is only necessary for `out' parameters and the
// call will always succeed for non-`out' parameters.
//
public bool IsParameterAssigned (int number)
{
if (DoFlowAnalysis)
return CurrentBranching.IsParameterAssigned (number);
else
return true;
}
//
// Marks the parameter `number' as being initialized at the current
// current point of the method's control flow. This is only necessary
// for `out' parameters.
//
public void SetParameterAssigned (int number)
{
if (DoFlowAnalysis)
CurrentBranching.SetParameterAssigned (number);
}
// These are two overloaded methods for EmitTopBlock
// since in MonoBasic functions we need the Function name
// along with its top block, in order to be able to
// retrieve the return value when there is no explicit
// 'Return' statement
public void EmitTopBlock (Block block, InternalParameters ip, Location loc)
{
EmitTopBlock (block, "", ip, loc);
}
public void EmitTopBlock (Block block, string bname, InternalParameters ip, Location loc)
{
bool has_ret = false;
//Console.WriteLine ("Emitting: '{0}", bname);
BlockName = bname;
if (CodeGen.SymbolWriter != null)
Mark (loc);
if (block != null){
int errors = Report.Errors;
block.EmitMeta (this, block);
if (Report.Errors == errors){
bool old_do_flow_analysis = DoFlowAnalysis;
DoFlowAnalysis = true;
FlowBranching cfb = new FlowBranching (block, ip, loc);
FlowStack.Push (cfb);
if (!block.Resolve (this)) {
FlowStack.Pop ();
DoFlowAnalysis = old_do_flow_analysis;
return;
}
cfb = (FlowBranching) FlowStack.Pop ();
FlowReturns returns = cfb.MergeTopBlock ();
DoFlowAnalysis = old_do_flow_analysis;
has_ret = block.Emit (this);
if ((returns == FlowReturns.ALWAYS) ||
(returns == FlowReturns.EXCEPTION) ||
(returns == FlowReturns.UNREACHABLE))
has_ret = true;
if (Report.Errors == errors){
if (RootContext.WarningLevel >= 3)
block.UsageWarning ();
}
}
}
if (ReturnType != null && !has_ret){
//
// mcs here would report an error (and justly so), but functions without
// an explicit return value are perfectly legal in MonoBasic
//
VariableInfo vi = block.GetVariableInfo (bname);
if (vi != null)
{
ig.Emit (OpCodes.Ldloc, vi.LocalBuilder);
ig.Emit (OpCodes.Ret);
}
else
Report.Error (-200, "This is not supposed to happen !");
return;
}
if (HasReturnLabel)
ig.MarkLabel (ReturnLabel);
if (return_value != null){
ig.Emit (OpCodes.Ldloc, return_value);
ig.Emit (OpCodes.Ret);
} else {
if (!InTry){
if (!has_ret || HasReturnLabel)
ig.Emit (OpCodes.Ret);
}
}
}
///
/// This is called immediately before emitting an IL opcode to tell the symbol
/// writer to which source line this opcode belongs.
///
public void Mark (Location loc)
{
if ((CodeGen.SymbolWriter != null) && !Location.IsNull (loc)) {
ISymbolDocumentWriter doc = loc.SymbolDocument;
if (doc != null)
ig.MarkSequencePoint (doc, loc.Row, 0, loc.Row, 0);
}
}
///
/// Returns a temporary storage for a variable of type t as
/// a local variable in the current body.
///
public LocalBuilder GetTemporaryStorage (Type t)
{
LocalBuilder location;
if (temporary_storage != null){
location = (LocalBuilder) temporary_storage [t];
if (location != null)
return location;
}
location = ig.DeclareLocal (t);
return location;
}
public void FreeTemporaryStorage (LocalBuilder b)
{
// Empty for now.
}
///
/// Current loop begin and end labels.
///
public Label LoopBegin, LoopEnd;
///
/// Whether we are inside a loop and break/continue are possible.
///
public bool InLoop;
///
/// This is incremented each time we enter a try/catch block and
/// decremented if we leave it.
///
public int TryCatchLevel;
///
/// The TryCatchLevel at the begin of the current loop.
///
public int LoopBeginTryCatchLevel;
///
/// Default target in a switch statement. Only valid if
/// InSwitch is true
///
public Label DefaultTarget;
///
/// If this is non-null, points to the current switch statement
///
public Switch Switch;
///
/// ReturnValue creates on demand the LocalBuilder for the
/// return value from the function. By default this is not
/// used. This is only required when returns are found inside
/// Try or Catch statements.
///
public LocalBuilder TemporaryReturn ()
{
if (return_value == null){
return_value = ig.DeclareLocal (ReturnType);
ReturnLabel = ig.DefineLabel ();
HasReturnLabel = true;
}
return return_value;
}
///
/// A dynamic This that is shared by all variables in a emitcontext.
/// Created on demand.
///
public Expression my_this;
public Expression This {
get {
if (my_this == null) {
if (CurrentBlock != null)
my_this = new This (CurrentBlock, loc);
else
my_this = new This (loc);
my_this = my_this.Resolve (this);
}
return my_this;
}
}
}
}