aesthetic changes
[mono.git] / web / c-sharp
index 96cb836879875555fed53effc1c5bbab4d59a967..07c13831039f565c7387d00adf07002696f7e03b 100644 (file)
@@ -1,15 +1,44 @@
 * MCS: The Ximian C# compiler
 
-       MCS began as an experiment to learn the features of C# by
-       writing a large C# program.  MCS is currently able to parse C#
-       programs and create an internal tree representation of the
-       program.  MCS can parse itself.  
+       MCS is currently able to compile itself and many more C#
+       programs (there is a test suite included that you can use).
 
-       Work is progressing quickly on various fronts in the C#
-       compiler.  Recently I started using the System.Reflection API
-       to load system type definitions and avoid self-population of
-       types in the compiler and dropped my internal Type
-       representation in favor of using the CLI's System.Type.  
+       We are in feature completion mode right now.  There are still
+       a couple of areas that are not covered by the Mono compiler, but
+       they are very very few at this point.
+
+       MCS was able to parse itself on April 2001, MCS compiled itself
+       for the first time on December 28 2001.  MCS became self hosting
+       on January 3rd, 2002. 
+
+       A test suite is maintained to track the progress of
+       the compiler and various programs are routinely compiled and
+       ran.
+
+** Obtaining MCS
+
+       The Mono C# compiler is part of the `mcs' module in the Mono CVS
+       you can get it from our <a href="anoncvs.html">Anonymous CVS</a> server,
+       or you can get nightly <a href="download.html">download page</a>.
+
+** Running MCS
+
+       MCS is written in C# and uses heavily the .NET APIs.  At this point
+       MCS only runs on Windows with the .NET Framework SDK installed.  Work
+       is progressing rapidly in our JIT engine and our class libraries to
+       allow MCS to be ran in non-Windows systems. 
+
+** Reporting Bugs in MCS
+
+       When you report a bug, try to provide a small test case that would
+       show the error so we can include this as part of the Mono C# regression
+       test suite.
+
+       If the bug is an error or a warning that we do not flag, write
+       a sample program called `csXXXX.cs' where XXXX is the code number
+       that is used by the Microsoft C# compiler that illustrates the 
+       problem.  That way we can also do regression tests on the invalid
+       input.  
 
 ** Phases of the compiler
 
                  have to postpone this decision until the above steps
                  are finished.
 
-               * Code generation: nothing done so far, but I do not
-                 expect this to be hard, as I will just use
-                 System.Reflection.Emit to generate the code. 
-       
+               * Code generation: The code generation is done through
+                 the System.Reflection.Emit API.
        </ul>
 
-<a name="tasks">
-** Current pending tasks
-
-       Simple tasks:
-
-       <ul>
-               * Array declarations are currently being ignored, 
+** CIL Optimizations.
 
-               * PInvoke declarations are not supported.
+       The compiler performs a number of simple optimizations on its input:
+       constant folding (this is required by the C# language spec) and 
+       can perform dead code elimination.
 
-               * Pre-processing is not supported.
+       Other more interesting optimizations like hoisting are not possible
+       at this point since the compiler output at this point does not
+       generate an intermediate representation that is suitable to
+       perform basic block computation.  
 
-               * Attribute declarations and passing currently ignored.
+       Adding an intermediate layer to enable the basic block
+       computation to the compiler should be a simple task, but we
+       are considering having a generic CIL optimizer.  Since all the
+       information that is required to perform basic block-based
+       optimizations is available at the CIL level, we might just skip
+       this step altogether and have just a generic IL optimizer that
+       would perform hoisting on arbitrary CIL programs, not only
+       those produced by MCS.  
 
-               * Compiler does not pass around line/col information from tokenizer for error reporting.
+       If this tool is further expanded to perform constant folding
+       (not needed for our C# compiler, as it is already in there)
+       and dead code elimination, other compiler authors might be
+       able to use this generic CIL optimizer in their projects
+       reducing their time to develop a production compiler. 
 
-               * Jay does not work correctly with `error'
-                 productions, making parser errors hard to point.  It
-                 would be best to port the Bison-To-Java compiler to
-                 become Bison-to-C# compiler (bjepson@oreilly.com
-                 might have more information)
-       </ul>
+<a name="tasks">
+** Current pending tasks
 
-       Critical tasks:
+       Simple tasks:
 
        <ul>
-               * Resolve "base" classes and "base" interfaces for
-                 classes, structs and interfaces.
-
-                 Once this is done, we can actually do the semantic
-                 analysis, because otherwise we do not know who our
-                 parents are.
+               * Redo the way we deal with built-in operators.
        </ul>
 
-       Interesting tasks:
-
+       Larger tasks:
        <ul>
-               * Finishing the JB port from Java to C#.  If you are
-                 interested in working on this, please contact Brian
-                 Jepson (bjepson at oreilly d-o-t com).
 
-                 More on JB at: <a href="http://www.cs.colorado.edu/~dennis/software/jb.html">
-                 http://www.cs.colorado.edu/~dennis/software/jb.html</a>
+               * Jay does not work correctly with `error'
+                 productions, making parser errors hard to point.  It
+                 would be best to port the Bison-To-Java compiler to
+                 become Bison-to-C# compiler. 
+                 
+                 Nick Drochak has started a project on SourceForge for this.
+                 You can find the project at: <a href="http://sourceforge.net/projects/jb2csharp/">
+                 http://sourceforge.net/projects/jb2csharp/</a>
+
+               * Semantic Analysis: Return path coverage and
+                 initialization before use coverage are two great
+                 features of C# that help reduce the number of bugs
+                 in applications.  It is one interesting hack.
 
-                 JB will allow us to move from the Berkeley Yacc
-                 based Jay to a Bison-based compiler (better error
-                 reporting and recovery).
        </ul>
 
 ** Questions and Answers
@@ -123,6 +155,10 @@ Q: If your C# compiler is written in C#, how do you plan on getting
    We will do this through an implementation of the CLI Virtual
    Execution System for Unix (our JIT engine). 
 
+   Our JIT engine is working for the purposes of using the compiler.
+   The supporting class libraries are being worked on to fully support
+   the compiler.
+
 Q: Do you use Bison?
 
 A: No, currently I am using Jay which is a port of Berkeley Yacc to
@@ -133,5 +169,53 @@ A: No, currently I am using Jay which is a port of Berkeley Yacc to
    In the future I want to port one of the Bison/Java ports to C# for
    the parser.
 
+Q: Should someone work on a GCC front-end to C#?
+
+A: I would love if someone does, and we would love to help anyone that
+   takes on that task, but we do not have the time or expertise to
+   build a C# compiler with the GCC engine.  I find it a lot more fun
+   personally to work on C# on a C# compiler, which has an intrinsic
+   beauty.
+
+   We can provide help and assistance to anyone who would like to work
+   on this task.
+
+Q: Should someone make a GCC backend that will generate CIL images?
+
+A: I would love to see a backend to GCC that generates CIL images.  It
+   would provide a ton of free compilers that would generate CIL
+   code.  This is something that people would want to look into
+   anyways for Windows interoperation in the future.
+
+   Again, we would love to provide help and assistance to anyone
+   interested in working in such a project.
+
+Q: What about making a front-end to GCC that takes CIL images and
+   generates native code?
+
+A: I would love to see this, specially since GCC supports this same
+   feature for Java Byte Codes.  You could use the metadata library
+   from Mono to read the byte codes (ie, this would be your
+   "front-end") and generate the trees that get passed to the
+   optimizer.
+
+   Ideally our implementation of the CLI will be available as a shared
+   library that could be linked with your application as its runtime
+   support. 
+
+   Again, we would love to provide help and assistance to anyone
+   interested in working in such a project.
+   
+Q: But would this work around the GPL in the GCC compiler and allow
+   people to work on non-free front-ends?
+
+A: People can already do this by targeting the JVM byte codes (there
+   are about 130 compilers for various languages that target the JVM).
+
+Q: Why are you writing a JIT engine instead of a front-end to GCC?
+
+A: The JIT engine and runtime engine will be able to execute CIL
+   executables generated on Windows.
+
 You might also want to look at the <a href="faq.html#gcc">GCC</a>
 section on the main FAQ