Difference between revisions of "Tools"

Revision as of 00:36, 14 July 2005

SmartEiffel provides many tools besides the compiler.

All those tools use the configuration file.

The tools

Tool box

se: a façade to all those tools

Compiling

clean: remove the useless C files
compile: the compiler (calls compile_to_c)
compile_to_c: the C compiler core
compile_to_jvm : the Java compiler

Searching and documenting

eiffeldoc: generates the whole documentation of a project
finder: find a class
pretty: make your source file pretty
short: generates the interface documentation of a single class

Debugging

ace_check: check an ACE file
class_check: check the syntax and the semantics of a source code
print_jvm_class: the Java bytecode disassembler

Installing

install: installs the SmartEiffel tools

The system core

If you are interested by how the system works, either by sheer curiosity, either because you want to modify it, here are some explanations.

syntactic analysis
sémantic analysis
the optimizer
the visitors
code generation
- compile_to_c
- compile_to_jvm

@@ Line 1: / Line 1: @@
-[[Category:Book]]
+[[Category: Book]]
+SmartEiffel provides many tools besides the [[compile|compiler]].
- *** TO BE COMPLETED (see French version)
- *** Thanks!
-[[SmartEiffel]] provides many tools besides the [[compile|compiler]].
+All those tools use the [[configuration file]].
-== The current tools (version 2.1) ==
+== The tools ==
+=== Tool box ===
+* [[se]]: a façade to all those tools
+=== Compiling ===
+* [[clean]]: remove the useless C files
 * [[compile]]: the compiler (calls [[compile_to_c]])
 * [[compile_to_c]]: the C compiler core
-* [[finder]]: the class finder
+* [[compile_to_jvm]]&nbsp;: the Java compiler
-* [[pretty]]: the class beautifier
+=== Searching and documenting ===
-* [[short]]: the class interface documentator
-* [[class_check]]: the class [[syntax]] and [[semantics]] checker
-* [[ace_check]]: the [[ACE file]] checker
+* [[eiffeldoc]]: generates the whole documentation of a project
+* [[finder]]: find a class
+* [[pretty]]: make your source file pretty
+* [[short]]: generates the interface documentation of a single class
+=== Debugging ===
+* [[ace_check]]: check an [[ACE|ACE file]]
+* [[class_check]]: check the [[parsing|syntax]] and the [[semantics]] of a source code
+* [[print_jvm_class]]: the Java bytecode disassembler
+=== Installing ===
+* [[install]]: installs the SmartEiffel tools
-== The upcoming tools (for 2.2) ==
+== The system core ==
+If you are interested by how the system works, either by sheer curiosity, either because you want to modify it, here are some explanations.
-Along with the existing tools, a few new tools will be included in the 2.2 release:
+* [[parsing|syntactic analysis]]
-* [[se]]: the front-end to all tools
+* [[semantics|sémantic analysis]]
-* [[eiffeldoc]]: the project documentator
+* the [[optimizer]]
-* [[compile_to_jvm]]: the JVM compiler, back to life from 1.1
+* the [[visitor|visitors]]
+* code generation
+** [[compile_to_c#Generation|compile_to_c]]
+** [[compile_to_jvm#Generation|compile_to_jvm]]