Index: src/CodeGen/FixNames.cc =================================================================== --- src/CodeGen/FixNames.cc (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/CodeGen/FixNames.cc (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FixNames.cc -- +// FixNames.cc -- Adjustments to typed declarations. // // Author : Richard C. Bilson Index: src/CodeGen/FixNames.h =================================================================== --- src/CodeGen/FixNames.h (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/CodeGen/FixNames.h (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FixNames.h -- +// FixNames.h -- Adjustments to typed declarations. // // Author : Richard C. Bilson @@ -26,5 +26,6 @@ /// mangles object and function names void fixNames( std::list< Declaration* > & translationUnit ); - void fixNames( ast::TranslationUnit & translationUnit ); +/// Sets scope levels and fills in main's default return. +void fixNames( ast::TranslationUnit & translationUnit ); } // namespace CodeGen Index: src/Concurrency/Keywords.h =================================================================== --- src/Concurrency/Keywords.h (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Concurrency/Keywords.h (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -28,9 +28,9 @@ void implementThreadStarter( std::list< Declaration * > & translationUnit ); -/// Implement the sue-like keywords and the suspend keyword. +/// Implement the sue-like keywords and the suspend keyword. Pre-Autogen void implementKeywords( ast::TranslationUnit & translationUnit ); -/// Implement the mutex parameters and mutex statement. +/// Implement the mutex parameters and mutex statement. Post-Autogen void implementMutex( ast::TranslationUnit & translationUnit ); -/// Add the thread starter code to constructors. +/// Add the thread starter code to constructors. Post-Autogen void implementThreadStarter( ast::TranslationUnit & translationUnit ); }; Index: src/ControlStruct/ExceptDecl.cc =================================================================== --- src/ControlStruct/ExceptDecl.cc (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/ControlStruct/ExceptDecl.cc (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// ExceptDecl.cc -- +// ExceptDecl.cc -- Handles declarations of exception types. // // Author : Henry Xue Index: src/ControlStruct/ExceptDecl.h =================================================================== --- src/ControlStruct/ExceptDecl.h (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/ControlStruct/ExceptDecl.h (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// ExceptDecl.h -- +// ExceptDecl.h -- Handles declarations of exception types. // // Author : Henry Xue @@ -25,5 +25,7 @@ namespace ControlStruct { - void translateExcept( std::list< Declaration *> & translationUnit ); - void translateExcept( ast::TranslationUnit & translationUnit ); +/// Unfold exception declarations into raw structure declarations. +/// Also builds vtable declarations and converts vtable types. +void translateExcept( std::list< Declaration *> & translationUnit ); +void translateExcept( ast::TranslationUnit & translationUnit ); } Index: src/ControlStruct/HoistControlDecls.hpp =================================================================== --- src/ControlStruct/HoistControlDecls.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/ControlStruct/HoistControlDecls.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -21,5 +21,6 @@ namespace ControlStruct { -// Hoist declarations out of control flow statements into compound statement. +/// Hoist declarations out of control flow statements into compound statement. +/// Must happen before auto-gen routines are added. void hoistControlDecls( ast::TranslationUnit & translationUnit ); } // namespace ControlStruct Index: src/InitTweak/GenInit.cc =================================================================== --- src/InitTweak/GenInit.cc (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/InitTweak/GenInit.cc (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// GenInit.cc -- +// GenInit.cc -- Generate initializers, and other stuff. // // Author : Rob Schluntz Index: src/InitTweak/GenInit.h =================================================================== --- src/InitTweak/GenInit.h (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/InitTweak/GenInit.h (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// GenInit.h -- +// GenInit.h -- Generate initializers, and other stuff. // // Author : Rodolfo G. Esteves @@ -29,5 +29,6 @@ void genInit( ast::TranslationUnit & translationUnit ); - /// Converts return statements into copy constructor calls on the hidden return variable + /// Converts return statements into copy constructor calls on the hidden return variable. + /// This pass must happen before auto-gen. void fixReturnStatements( std::list< Declaration * > & translationUnit ); void fixReturnStatements( ast::TranslationUnit & translationUnit ); Index: src/Tuples/Tuples.cc =================================================================== --- src/Tuples/Tuples.cc (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Tuples/Tuples.cc (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// Tuples.h -- +// Tuples.cc -- A collection of tuple operations. // // Author : Andrew Beach Index: src/Tuples/Tuples.h =================================================================== --- src/Tuples/Tuples.h (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Tuples/Tuples.h (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// Tuples.h -- +// Tuples.h -- A collection of tuple operations. // // Author : Rodolfo G. Esteves Index: src/Validate/Autogen.hpp =================================================================== --- src/Validate/Autogen.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/Autogen.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -22,4 +22,6 @@ namespace Validate { +/// Generate routines for all data types in the translation unit. +/// A lot of passes have to happen either before or after this pass. void autogenerateRoutines( ast::TranslationUnit & translationUnit ); Index: src/Validate/CompoundLiteral.hpp =================================================================== --- src/Validate/CompoundLiteral.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/CompoundLiteral.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -23,4 +23,5 @@ /// Use variables to implement compound literals. +/// Must happen after auto-gen routines are added. void handleCompoundLiterals( ast::TranslationUnit & translationUnit ); Index: src/Validate/EnumAndPointerDecay.cpp =================================================================== --- src/Validate/EnumAndPointerDecay.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/EnumAndPointerDecay.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// EnumAndPointerDecay.cpp -- +// EnumAndPointerDecay.cpp -- Normalizes enumerations and types in functions. // // Author : Andrew Beach Index: src/Validate/EnumAndPointerDecay.hpp =================================================================== --- src/Validate/EnumAndPointerDecay.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/EnumAndPointerDecay.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// EnumAndPointerDecay.hpp -- +// EnumAndPointerDecay.hpp -- Normalizes enumerations and types in functions. // // Author : Andrew Beach @@ -22,4 +22,7 @@ namespace Validate { +/// Fix the parameter and return types of functions. Also assigns types to +/// enumeration values. This must happen before Link Reference to Types, +/// it needs correct types for mangling, and before auto-gen. void decayEnumsAndPointers( ast::TranslationUnit & translationUnit ); Index: src/Validate/FindSpecialDecls.h =================================================================== --- src/Validate/FindSpecialDecls.h (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/FindSpecialDecls.h (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FindSpecialDeclarations.h -- +// FindSpecialDeclarations.h -- Find special declarations used in the compiler. // // Author : Rob Schluntz @@ -43,5 +43,5 @@ void findSpecialDecls( std::list< Declaration * > & translationUnit ); -/// find and remember some of the special declarations that are useful for +/// Find and remember some of the special declarations that are useful for /// generating code, so that they do not have to be discovered multiple times. void findGlobalDecls( ast::TranslationUnit & translationUnit ); Index: src/Validate/FixQualifiedTypes.cpp =================================================================== --- src/Validate/FixQualifiedTypes.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/FixQualifiedTypes.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FixQualifiedTypes.cpp -- +// FixQualifiedTypes.cpp -- Replace the qualified type with a direct type. // // Author : Andrew Beach @@ -76,5 +76,4 @@ ret->qualifiers = type->qualifiers; ast::TypeSubstitution sub( aggr->params, instp->params ); - // = parent->genericSubstitution(); auto result = sub.apply(ret); return result.node.release(); Index: src/Validate/FixQualifiedTypes.hpp =================================================================== --- src/Validate/FixQualifiedTypes.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/FixQualifiedTypes.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FixQualifiedTypes.hpp -- +// FixQualifiedTypes.hpp -- Replace the qualified type with a direct type. // // Author : Andrew Beach @@ -22,4 +22,7 @@ namespace Validate { +/// Replaces qualified types with an unqualified NamedTypeDecl. +/// Must happen after Link References To Types, +/// because aggregate members are accessed. void fixQualifiedTypes( ast::TranslationUnit & translationUnit ); Index: src/Validate/FixReturnTypes.cpp =================================================================== --- src/Validate/FixReturnTypes.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/FixReturnTypes.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FixReturnTypes.cpp -- +// FixReturnTypes.cpp -- Unifies the representation of return types. // // Author : Andrew Beach Index: src/Validate/FixReturnTypes.hpp =================================================================== --- src/Validate/FixReturnTypes.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/FixReturnTypes.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// FixReturnTypes.hpp -- +// FixReturnTypes.hpp -- Unifies the representation of return types. // // Author : Andrew Beach @@ -22,6 +22,7 @@ namespace Validate { -// This pass needs to happen early so that other passes can find tuple types -// in the right places, especially for function return types. +/// This pass needs to happen early so that other passes can find tuple types +/// in the right places, especially for function return types. +/// Must happen before auto-gen. void fixReturnTypes( ast::TranslationUnit & translationUnit ); Index: src/Validate/ForallPointerDecay.hpp =================================================================== --- src/Validate/ForallPointerDecay.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/ForallPointerDecay.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -29,4 +29,7 @@ /// Also checks that operator names are used properly on functions and /// assigns unique IDs. This is a "legacy" pass. +/// Must be after implement concurrent keywords; because uniqueIds must be +/// set on declaration before resolution. +/// Must happen before auto-gen routines are added. void decayForallPointers( ast::TranslationUnit & transUnit ); Index: src/Validate/GenericParameter.cpp =================================================================== --- src/Validate/GenericParameter.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/GenericParameter.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// GenericParameter.hpp -- +// GenericParameter.hpp -- Generic parameter related passes. // // Author : Andrew Beach Index: src/Validate/GenericParameter.hpp =================================================================== --- src/Validate/GenericParameter.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/GenericParameter.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// GenericParameter.hpp -- +// GenericParameter.hpp -- Generic parameter related passes. // // Author : Andrew Beach @@ -23,4 +23,6 @@ /// Perform substutions for generic parameters and fill in defaults. +/// Check as early as possible, but it can't happen before Link References to +/// Types and observed failing when attempted before eliminate typedef. void fillGenericParameters( ast::TranslationUnit & translationUnit ); Index: src/Validate/HoistStruct.hpp =================================================================== --- src/Validate/HoistStruct.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/HoistStruct.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -22,5 +22,5 @@ namespace Validate { -/// Flattens nested type declarations. +/// Flattens nested type declarations. (Run right after Fix Qualified Types.) void hoistStruct( ast::TranslationUnit & translationUnit ); Index: src/Validate/HoistTypeDecls.cpp =================================================================== --- src/Validate/HoistTypeDecls.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/HoistTypeDecls.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// HoistTypeDecls.cpp -- +// HoistTypeDecls.cpp -- Hoists declarations of implicitly declared types. // // Author : Andrew Beach Index: src/Validate/HoistTypeDecls.hpp =================================================================== --- src/Validate/HoistTypeDecls.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/HoistTypeDecls.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// HoistTypeDecls.hpp -- +// HoistTypeDecls.hpp -- Hoists declarations of implicitly declared types. // // Author : Andrew Beach @@ -22,4 +22,7 @@ namespace Validate { +/// There are some places where a type can be declared but are usually only +/// referenced (with an *InstType). This inserts the declarations before +/// they are referenced. void hoistTypeDecls( ast::TranslationUnit & translationUnit ); Index: src/Validate/LabelAddressFixer.cpp =================================================================== --- src/Validate/LabelAddressFixer.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/LabelAddressFixer.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// LabelAddressFixer.cpp -- +// LabelAddressFixer.cpp -- Create label address expressions. // // Author : Andrew Beach Index: src/Validate/LabelAddressFixer.hpp =================================================================== --- src/Validate/LabelAddressFixer.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/LabelAddressFixer.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// LabelAddressFixer.hpp -- +// LabelAddressFixer.hpp -- Create label address expressions. // // Author : Andrew Beach @@ -20,4 +20,6 @@ namespace Validate { +/// Label addresses are not actually created in the parser, this pass finds +/// the patterns that represent the label address expression. void fixLabelAddresses( ast::TranslationUnit & translationUnit ); Index: src/Validate/LinkReferenceToTypes.hpp =================================================================== --- src/Validate/LinkReferenceToTypes.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/LinkReferenceToTypes.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -22,4 +22,7 @@ namespace Validate { +/// Fills in the base value of various instance types, and some related +/// adjustments, such as setting the sized flag. +/// Because of the sized flag, it must happen before auto-gen. void linkReferenceToTypes( ast::TranslationUnit & translationUnit ); Index: src/Validate/ReplaceTypedef.cpp =================================================================== --- src/Validate/ReplaceTypedef.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/ReplaceTypedef.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// ReplaceTypedef.cpp -- +// ReplaceTypedef.cpp -- Fill in all typedefs with the underlying type. // // Author : Andrew Beach Index: src/Validate/ReplaceTypedef.hpp =================================================================== --- src/Validate/ReplaceTypedef.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/ReplaceTypedef.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// ReplaceTypedef.hpp -- +// ReplaceTypedef.hpp -- Fill in all typedefs with the underlying type. // // Author : Andrew Beach @@ -22,4 +22,5 @@ namespace Validate { +/// Uses of typedef are replaced with the type in the typedef. void replaceTypedef( ast::TranslationUnit & translationUnit ); Index: src/Validate/VerifyCtorDtorAssign.cpp =================================================================== --- src/Validate/VerifyCtorDtorAssign.cpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/VerifyCtorDtorAssign.cpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// VerifyCtorDtorAssign.cpp -- +// VerifyCtorDtorAssign.cpp -- Check the form of operators. // // Author : Andrew Beach Index: src/Validate/VerifyCtorDtorAssign.hpp =================================================================== --- src/Validate/VerifyCtorDtorAssign.hpp (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/Validate/VerifyCtorDtorAssign.hpp (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -5,5 +5,5 @@ // file "LICENCE" distributed with Cforall. // -// VerifyCtorDtorAssign.hpp -- +// VerifyCtorDtorAssign.hpp -- Check the form of operators. // // Author : Andrew Beach @@ -22,4 +22,6 @@ namespace Validate { +/// Check that constructors, destructors and assignments all have the correct +/// form. Must happen before auto-gen or anything that examines operators. void verifyCtorDtorAssign( ast::TranslationUnit & translationUnit ); Index: src/main.cc =================================================================== --- src/main.cc (revision 0577df2ebf16c54042e9bf74bca99c6a5bcb4b19) +++ src/main.cc (revision 11df881444fe5fe1691782e35ebfec8a06555fa6) @@ -345,7 +345,5 @@ } - // Must happen before auto-gen, or anything that examines ops. PASS( "Verify Ctor, Dtor & Assign", Validate::verifyCtorDtorAssign( transUnit ) ); - PASS( "Hoist Type Decls", Validate::hoistTypeDecls( transUnit ) ); // Hoist Type Decls pulls some declarations out of contexts where @@ -355,45 +353,20 @@ PASS( "Replace Typedefs", Validate::replaceTypedef( transUnit ) ); - - // Must happen before auto-gen. PASS( "Fix Return Types", Validate::fixReturnTypes( transUnit ) ); - - // Must happen before Link Reference to Types, it needs correct - // types for mangling. PASS( "Enum and Pointer Decay", Validate::decayEnumsAndPointers( transUnit ) ); - // Must happen before auto-gen, because it uses the sized flag. PASS( "Link Reference To Types", Validate::linkReferenceToTypes( transUnit ) ); - // Must happen after Link References To Types, - // because aggregate members are accessed. PASS( "Fix Qualified Types", Validate::fixQualifiedTypes( transUnit ) ); - PASS( "Hoist Struct", Validate::hoistStruct( transUnit ) ); PASS( "Eliminate Typedef", Validate::eliminateTypedef( transUnit ) ); - - // Check as early as possible. Can't happen before - // LinkReferenceToType, observed failing when attempted - // before eliminateTypedef PASS( "Validate Generic Parameters", Validate::fillGenericParameters( transUnit ) ); - PASS( "Translate Dimensions", Validate::translateDimensionParameters( transUnit ) ); PASS( "Check Function Returns", Validate::checkReturnStatements( transUnit ) ); - - // Must happen before Autogen. PASS( "Fix Return Statements", InitTweak::fixReturnStatements( transUnit ) ); - PASS( "Implement Concurrent Keywords", Concurrency::implementKeywords( transUnit ) ); - - // Must be after implement concurrent keywords; because uniqueIds - // must be set on declaration before resolution. - // Must happen before autogen routines are added. PASS( "Forall Pointer Decay", Validate::decayForallPointers( transUnit ) ); - - // Must happen before autogen routines are added. PASS( "Hoist Control Declarations", ControlStruct::hoistControlDecls( transUnit ) ); - // Must be after enum and pointer decay. - // Must be before compound literals. PASS( "Generate Autogen Routines", Validate::autogenerateRoutines( transUnit ) );