Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / mcs / docs / compiler.txt
index 0ddfca2da33bc724a11a3173e2bdb2a800af694a..9e516ffd01cf38d0b47eb7b4ee55459617f66ae9 100755 (executable)
@@ -71,7 +71,7 @@
                Code to do semantic analysis and emit the attributes
                is here.
 
-           rootcontext.cs:
+           module.cs:
 
                Keeps track of the types defined in the source code,
                as well as the assemblies loaded.  
        The token 0 is reserved for ``anonymous'' locations, ie. if we
        don't know the location (Location.Null).
 
-       The tokenizer also tracks the column number for a token, but
-       this is currently not being used or encoded.  It could
-       probably be encoded in the low 9 bits, allowing for columns
-       from 1 to 512 to be encoded.
-
 * The Parser
 
        The parser is written using Jay, which is a port of Berkeley
 
        In the Mono C# compiler, we use a class for each of the
        statements and expressions in the C# language.  For example,
-       there is a `While' class for the the `while' statement, a
+       there is a `While' class for the `while' statement, a
        `Cast' class to represent a cast expression and so on.
 
        There is a Statement class, and an Expression class which are
 
        During parsing, the compiler will create the various trees of
        expressions.  These expressions have to be resolved before they
-       are can be used.    The semantic analysis is implemented by
+       can be used.    The semantic analysis is implemented by
        resolving each of the expressions created during parsing and
        creating fully resolved expressions.
 
 
        a [i++]++ 
        a [i++] += 5;
+       
+** Optimalizations
+
+       Compiler does some limited high-level optimalizations when
+       -optimize option is used
+
+*** Instance field initializer to default value
+
+       Code to optimize:
+
+       class C
+       {
+               enum E
+               {
+                       Test
+               }
+    
+               int i = 0;  // Field will not be redundantly assigned
+               int i2 = new int (); // This will be also completely optimized out
+    
+               E e = E.Test; // Even this will go out.
+       }
 
 ** Statements
 
 
                * Elements that contain code are now invoked to
                  perform semantic analysis and code generation.
+                 
+* References loading
+
+       Most programs use external references (assemblies and modules).
+       Compiler loads all referenced top-level types from referenced
+       assemblies into import cached. It imports initialy only C#
+       valid top-level types all other members are imported on demand
+       when needed.
+
+* Namespaces definition
+
+       Before any type resolution can be done we define all compiled
+       namespaces. This is mainly done to prepare using clauses of each
+       namespace block before any type resolution takes a place.
+
+* Types definition
+
+       The first step of type definition is to resolve base class or
+       base interfaces to correctly setup type hierarchy before any
+       member is defined.
+       
+       At this point we do some error checking and verify that the
+       members inheritance is correct and some other members
+       oriented checks.
+
+       By the time we are done, all classes, structs and interfaces
+       have been defined and all their members have been defined as
+       well.
+       
+* MemberCache
+
+       MemberCache is one of core compiler components. It maintains information
+       about types and their members. It tries to be as fast as possible
+       because almost all resolve operations end up querying members info in
+       some way.
+       
+       MemberCache is not definition but specification oriented to maintain
+       differences between inflated versions of generic types. This makes usage
+       of MemberCache simple because consumer does not need to care how to inflate
+       current member and returned type information will always give correctly
+       inflated type. However setting MemberCache up is one of the most complicated
+       parts of the compiler due to possible dependencies when types are defined
+       and complexity of nested types.
 
 * Output Generation
 
        into an empty operation.   Otherwise the above will become
        a return statement that can infer return types.
 
+* Debugger support
+
+       Compiler produces .mdb symbol file for better debugging experience. The
+       process is quite straightforward. For every statement or a block there
+       is an entry in symbol file. Each entry includes of start location of
+       the statement and it's starting IL offset in the method. For most statements
+       this is easy but few need special handling (e.g. do, while).
+       
+       When sequence point is needed to represent original location and no IL
+       entry is written for the line we emit `nop' instruction. This is done only
+       for very few constructs (e.g. block opening brace).
+       
+       Captured variables are not treated differently at the moment. Debugger has
+       internal knowledge of their mangled names and how to decode them.
+
+* IKVM.Reflection vs System.Reflection
+
+       Mono compiler can be compiled using different reflection backends. At the
+       moment we support System.Reflection and IKVM.Reflection they both use same
+       API as official System.Reflection.Emit API which allows us to maintain only
+       single version of compiler with few using aliases to specialise.
+       
+       The backends are not plug-able but require compiler to be compiled with
+       specific STATIC define when targeting IKVM.Reflection.
+       
+       IKVM.Reflection is used for static compilation. This means the compiler runs
+       in batch mode like most compilers do. It can target any runtime version and
+       use any mscorlib. The mcs.exe is using IKVM.Reflection.
+       
+       System.Reflection is used for dynamic compilation. This mode is used by
+       our REPL and Evaluator API. Produced IL code is not written to disc but
+       executed by runtime (JIT). Mono.CSharp.dll is using System.Reflection and
+       System.Reflection.Emit.
+
 * Evaluation API
 
        The compiler can now be used as a library, the API exposed
        $ csharp -v -v
 
        This will turn on the parser debugging output and will
-       generate a lot of data when parsing its input.
+       generate a lot of data when parsing its input (make sure that
+       your parser has been compiled with the -v flag, see above for 
+       details).
 
        To start with a new completion scheme, type your C# code and
        then hit the tab key to trigger the completion engine.  In the
        We then rebuild our compiler:
 
        (cd mcs/; make cs-parser.jay)
-       (cd tools/csharplib; make install)
+       (cd class/Mono.CSharp; make install)
 
        And re-run csharp: