[flang] Regularize TODO messages for coarray related features (#69227)

psteinfeld · web-flow · commit 5db4779c3f07 · 2023-10-16T12:37:57.000-07:00
I want to make "not yet implemented" messages for features related to
coarrays easy to identify and make them easy for users to read.
diff --git a/flang/lib/Lower/Allocatable.cpp b/flang/lib/Lower/Allocatable.cpp
@@ -462,7 +462,7 @@ class AllocateStmtHelper {
     errorManager.genStatCheck(builder, loc);
     genAllocateObjectInit(box);
     if (alloc.hasCoarraySpec())
-      TODO(loc, "coarray allocation");
+      TODO(loc, "coarray: allocation of a coarray object");
     if (alloc.type.IsPolymorphic())
       genSetType(alloc, box, loc);
     genSetDeferredLengthParameters(alloc, box);
@@ -582,7 +582,7 @@ class AllocateStmtHelper {
     errorManager.genStatCheck(builder, loc);
     genAllocateObjectInit(box);
     if (alloc.hasCoarraySpec())
-      TODO(loc, "coarray allocation");
+      TODO(loc, "coarray: allocation of a coarray object");
     // Set length of the allocate object if it has. Otherwise, get the length
     // from source for the deferred length parameter.
     if (lenParams.empty() && box.isCharacter() &&
diff --git a/flang/lib/Lower/Bridge.cpp b/flang/lib/Lower/Bridge.cpp
@@ -2625,35 +2625,35 @@ class FirConverter : public Fortran::lower::AbstractConverter {
   }
 
   void genFIR(const Fortran::parser::ChangeTeamConstruct &construct) {
-    TODO(toLocation(), "ChangeTeamConstruct implementation");
+    TODO(toLocation(), "coarray: ChangeTeamConstruct");
   }
   void genFIR(const Fortran::parser::ChangeTeamStmt &stmt) {
-    TODO(toLocation(), "ChangeTeamStmt implementation");
+    TODO(toLocation(), "coarray: ChangeTeamStmt");
   }
   void genFIR(const Fortran::parser::EndChangeTeamStmt &stmt) {
-    TODO(toLocation(), "EndChangeTeamStmt implementation");
+    TODO(toLocation(), "coarray: EndChangeTeamStmt");
   }
 
   void genFIR(const Fortran::parser::CriticalConstruct &criticalConstruct) {
     setCurrentPositionAt(criticalConstruct);
-    TODO(toLocation(), "CriticalConstruct implementation");
+    TODO(toLocation(), "coarray: CriticalConstruct");
   }
   void genFIR(const Fortran::parser::CriticalStmt &) {
-    TODO(toLocation(), "CriticalStmt implementation");
+    TODO(toLocation(), "coarray: CriticalStmt");
   }
   void genFIR(const Fortran::parser::EndCriticalStmt &) {
-    TODO(toLocation(), "EndCriticalStmt implementation");
+    TODO(toLocation(), "coarray: EndCriticalStmt");
   }
 
   void genFIR(const Fortran::parser::SelectRankConstruct &selectRankConstruct) {
     setCurrentPositionAt(selectRankConstruct);
-    TODO(toLocation(), "SelectRankConstruct implementation");
+    TODO(toLocation(), "coarray: SelectRankConstruct");
   }
   void genFIR(const Fortran::parser::SelectRankStmt &) {
-    TODO(toLocation(), "SelectRankStmt implementation");
+    TODO(toLocation(), "coarray: SelectRankStmt");
   }
   void genFIR(const Fortran::parser::SelectRankCaseStmt &) {
-    TODO(toLocation(), "SelectRankCaseStmt implementation");
+    TODO(toLocation(), "coarray: SelectRankCaseStmt");
   }
 
   void genFIR(const Fortran::parser::SelectTypeConstruct &selectTypeConstruct) {
diff --git a/flang/lib/Lower/CallInterface.cpp b/flang/lib/Lower/CallInterface.cpp
@@ -952,7 +952,7 @@ class Fortran::lower::CallInterfaceImpl {
     if (shapeAttrs.test(ShapeAttr::AssumedRank))
       TODO(loc, "assumed rank in procedure interface");
     if (shapeAttrs.test(ShapeAttr::Coarray))
-      TODO(loc, "coarray in procedure interface");
+      TODO(loc, "coarray: dummy argument coarray in procedure interface");
 
     // So far assume that if the argument cannot be passed by implicit interface
     // it must be by box. That may no be always true (e.g for simple optionals)
diff --git a/flang/lib/Lower/Coarray.cpp b/flang/lib/Lower/Coarray.cpp
@@ -27,27 +27,27 @@ void Fortran::lower::genChangeTeamConstruct(
     Fortran::lower::AbstractConverter &converter,
     Fortran::lower::pft::Evaluation &,
     const Fortran::parser::ChangeTeamConstruct &) {
-  TODO(converter.getCurrentLocation(), "CHANGE TEAM construct");
+  TODO(converter.getCurrentLocation(), "coarray: CHANGE TEAM construct");
 }
 
 void Fortran::lower::genChangeTeamStmt(
     Fortran::lower::AbstractConverter &converter,
     Fortran::lower::pft::Evaluation &,
     const Fortran::parser::ChangeTeamStmt &) {
-  TODO(converter.getCurrentLocation(), "CHANGE TEAM stmt");
+  TODO(converter.getCurrentLocation(), "coarray: CHANGE TEAM statement");
 }
 
 void Fortran::lower::genEndChangeTeamStmt(
     Fortran::lower::AbstractConverter &converter,
     Fortran::lower::pft::Evaluation &,
     const Fortran::parser::EndChangeTeamStmt &) {
-  TODO(converter.getCurrentLocation(), "END CHANGE TEAM");
+  TODO(converter.getCurrentLocation(), "coarray: END CHANGE TEAM statement");
 }
 
 void Fortran::lower::genFormTeamStatement(
     Fortran::lower::AbstractConverter &converter,
     Fortran::lower::pft::Evaluation &, const Fortran::parser::FormTeamStmt &) {
-  TODO(converter.getCurrentLocation(), "FORM TEAM");
+  TODO(converter.getCurrentLocation(), "coarray: FORM TEAM statement");
 }
 
 //===----------------------------------------------------------------------===//
diff --git a/flang/lib/Lower/ConvertExpr.cpp b/flang/lib/Lower/ConvertExpr.cpp
@@ -3814,7 +3814,7 @@ class ArrayExprLowering {
     return false;
   }
   bool genShapeFromDataRef(const Fortran::evaluate::CoarrayRef &) {
-    TODO(getLoc(), "coarray ref");
+    TODO(getLoc(), "coarray: reference to a coarray in an expression");
     return false;
   }
   bool genShapeFromDataRef(const Fortran::evaluate::Component &x) {
@@ -7091,7 +7091,7 @@ class ArrayExprLowering {
   }
 
   CC genarr(const Fortran::evaluate::CoarrayRef &x, ComponentPath &components) {
-    TODO(getLoc(), "coarray reference");
+    TODO(getLoc(), "coarray: reference to a coarray in an expression");
   }
 
   CC genarr(const Fortran::evaluate::NamedEntity &x,
diff --git a/flang/lib/Lower/ConvertExprToHLFIR.cpp b/flang/lib/Lower/ConvertExprToHLFIR.cpp
@@ -371,11 +371,11 @@ class HlfirDesignatorBuilder {
 
   fir::FortranVariableOpInterface
   gen(const Fortran::evaluate::CoarrayRef &coarrayRef) {
-    TODO(getLoc(), "lowering CoarrayRef to HLFIR");
+    TODO(getLoc(), "coarray: lowering a reference to a coarray object");
   }
 
   mlir::Type visit(const Fortran::evaluate::CoarrayRef &, PartInfo &) {
-    TODO(getLoc(), "lowering CoarrayRef to HLFIR");
+    TODO(getLoc(), "coarray: lowering a reference to a coarray object");
   }
 
   fir::FortranVariableOpInterface
diff --git a/flang/lib/Lower/Runtime.cpp b/flang/lib/Lower/Runtime.cpp
@@ -140,49 +140,49 @@ void Fortran::lower::genFailImageStatement(
 void Fortran::lower::genEventPostStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::EventPostStmt &) {
-  TODO(converter.getCurrentLocation(), "EVENT POST runtime");
+  TODO(converter.getCurrentLocation(), "coarray: EVENT POST runtime");
 }
 
 void Fortran::lower::genEventWaitStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::EventWaitStmt &) {
-  TODO(converter.getCurrentLocation(), "EVENT WAIT runtime");
+  TODO(converter.getCurrentLocation(), "coarray: EVENT WAIT runtime");
 }
 
 void Fortran::lower::genLockStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::LockStmt &) {
-  TODO(converter.getCurrentLocation(), "LOCK runtime");
+  TODO(converter.getCurrentLocation(), "coarray: LOCK runtime");
 }
 
 void Fortran::lower::genUnlockStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::UnlockStmt &) {
-  TODO(converter.getCurrentLocation(), "UNLOCK runtime");
+  TODO(converter.getCurrentLocation(), "coarray: UNLOCK runtime");
 }
 
 void Fortran::lower::genSyncAllStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::SyncAllStmt &) {
-  TODO(converter.getCurrentLocation(), "SYNC ALL runtime");
+  TODO(converter.getCurrentLocation(), "coarray: SYNC ALL runtime");
 }
 
 void Fortran::lower::genSyncImagesStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::SyncImagesStmt &) {
-  TODO(converter.getCurrentLocation(), "SYNC IMAGES runtime");
+  TODO(converter.getCurrentLocation(), "coarray: SYNC IMAGES runtime");
 }
 
 void Fortran::lower::genSyncMemoryStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::SyncMemoryStmt &) {
-  TODO(converter.getCurrentLocation(), "SYNC MEMORY runtime");
+  TODO(converter.getCurrentLocation(), "coarray: SYNC MEMORY runtime");
 }
 
 void Fortran::lower::genSyncTeamStatement(
     Fortran::lower::AbstractConverter &converter,
     const Fortran::parser::SyncTeamStmt &) {
-  TODO(converter.getCurrentLocation(), "SYNC TEAM runtime");
+  TODO(converter.getCurrentLocation(), "coarray: SYNC TEAM runtime");
 }
 
 void Fortran::lower::genPauseStatement(
diff --git a/flang/lib/Lower/VectorSubscripts.cpp b/flang/lib/Lower/VectorSubscripts.cpp
@@ -212,7 +212,8 @@ class VectorSubscriptBoxBuilder {
 
   mlir::Type gen(const Fortran::evaluate::CoarrayRef &) {
     // Is this possible/legal ?
-    TODO(loc, "coarray ref with vector subscript in IO input");
+    TODO(loc, "coarray: reference to coarray object with vector subscript in "
+              "IO input");
   }
 
   template <typename A>

Original file line number	Diff line number	Diff line change
`@@ -2625,35 +2625,35 @@ class FirConverter : public Fortran::lower::AbstractConverter {`
`2625`	`2625`	`}`
`2626`	`2626`
`2627`	`2627`	`void genFIR(const Fortran::parser::ChangeTeamConstruct &construct) {`
`2628`		`- TODO(toLocation(), "ChangeTeamConstruct implementation");`
	`2628`	`+ TODO(toLocation(), "coarray: ChangeTeamConstruct");`
`2629`	`2629`	`}`
`2630`	`2630`	`void genFIR(const Fortran::parser::ChangeTeamStmt &stmt) {`
`2631`		`- TODO(toLocation(), "ChangeTeamStmt implementation");`
	`2631`	`+ TODO(toLocation(), "coarray: ChangeTeamStmt");`
`2632`	`2632`	`}`
`2633`	`2633`	`void genFIR(const Fortran::parser::EndChangeTeamStmt &stmt) {`
`2634`		`- TODO(toLocation(), "EndChangeTeamStmt implementation");`
	`2634`	`+ TODO(toLocation(), "coarray: EndChangeTeamStmt");`
`2635`	`2635`	`}`
`2636`	`2636`
`2637`	`2637`	`void genFIR(const Fortran::parser::CriticalConstruct &criticalConstruct) {`
`2638`	`2638`	`setCurrentPositionAt(criticalConstruct);`
`2639`		`- TODO(toLocation(), "CriticalConstruct implementation");`
	`2639`	`+ TODO(toLocation(), "coarray: CriticalConstruct");`
`2640`	`2640`	`}`
`2641`	`2641`	`void genFIR(const Fortran::parser::CriticalStmt &) {`
`2642`		`- TODO(toLocation(), "CriticalStmt implementation");`
	`2642`	`+ TODO(toLocation(), "coarray: CriticalStmt");`
`2643`	`2643`	`}`
`2644`	`2644`	`void genFIR(const Fortran::parser::EndCriticalStmt &) {`
`2645`		`- TODO(toLocation(), "EndCriticalStmt implementation");`
	`2645`	`+ TODO(toLocation(), "coarray: EndCriticalStmt");`
`2646`	`2646`	`}`
`2647`	`2647`
`2648`	`2648`	`void genFIR(const Fortran::parser::SelectRankConstruct &selectRankConstruct) {`
`2649`	`2649`	`setCurrentPositionAt(selectRankConstruct);`
`2650`		`- TODO(toLocation(), "SelectRankConstruct implementation");`
	`2650`	`+ TODO(toLocation(), "coarray: SelectRankConstruct");`
`2651`	`2651`	`}`
`2652`	`2652`	`void genFIR(const Fortran::parser::SelectRankStmt &) {`
`2653`		`- TODO(toLocation(), "SelectRankStmt implementation");`
	`2653`	`+ TODO(toLocation(), "coarray: SelectRankStmt");`
`2654`	`2654`	`}`
`2655`	`2655`	`void genFIR(const Fortran::parser::SelectRankCaseStmt &) {`
`2656`		`- TODO(toLocation(), "SelectRankCaseStmt implementation");`
	`2656`	`+ TODO(toLocation(), "coarray: SelectRankCaseStmt");`
`2657`	`2657`	`}`
`2658`	`2658`
`2659`	`2659`	`void genFIR(const Fortran::parser::SelectTypeConstruct &selectTypeConstruct) {`
Original file line number	Diff line number	Diff line change
`@@ -3814,7 +3814,7 @@ class ArrayExprLowering {`
`3814`	`3814`	`return false;`
`3815`	`3815`	`}`
`3816`	`3816`	`bool genShapeFromDataRef(const Fortran::evaluate::CoarrayRef &) {`
`3817`		`- TODO(getLoc(), "coarray ref");`
	`3817`	`+ TODO(getLoc(), "coarray: reference to a coarray in an expression");`
`3818`	`3818`	`return false;`
`3819`	`3819`	`}`
`3820`	`3820`	`bool genShapeFromDataRef(const Fortran::evaluate::Component &x) {`
`@@ -7091,7 +7091,7 @@ class ArrayExprLowering {`
`7091`	`7091`	`}`
`7092`	`7092`
`7093`	`7093`	`CC genarr(const Fortran::evaluate::CoarrayRef &x, ComponentPath &components) {`
`7094`		`- TODO(getLoc(), "coarray reference");`
	`7094`	`+ TODO(getLoc(), "coarray: reference to a coarray in an expression");`
`7095`	`7095`	`}`
`7096`	`7096`
`7097`	`7097`	`CC genarr(const Fortran::evaluate::NamedEntity &x,`
Original file line number	Diff line number	Diff line change
`@@ -371,11 +371,11 @@ class HlfirDesignatorBuilder {`
`371`	`371`
`372`	`372`	`fir::FortranVariableOpInterface`
`373`	`373`	`gen(const Fortran::evaluate::CoarrayRef &coarrayRef) {`
`374`		`- TODO(getLoc(), "lowering CoarrayRef to HLFIR");`
	`374`	`+ TODO(getLoc(), "coarray: lowering a reference to a coarray object");`
`375`	`375`	`}`
`376`	`376`
`377`	`377`	`mlir::Type visit(const Fortran::evaluate::CoarrayRef &, PartInfo &) {`
`378`		`- TODO(getLoc(), "lowering CoarrayRef to HLFIR");`
	`378`	`+ TODO(getLoc(), "coarray: lowering a reference to a coarray object");`
`379`	`379`	`}`
`380`	`380`
`381`	`381`	`fir::FortranVariableOpInterface`
Original file line number	Diff line number	Diff line change
`@@ -212,7 +212,8 @@ class VectorSubscriptBoxBuilder {`
`212`	`212`
`213`	`213`	`mlir::Type gen(const Fortran::evaluate::CoarrayRef &) {`
`214`	`214`	`// Is this possible/legal ?`
`215`		`- TODO(loc, "coarray ref with vector subscript in IO input");`
	`215`	`+ TODO(loc, "coarray: reference to coarray object with vector subscript in "`
	`216`	`+ "IO input");`
`216`	`217`	`}`
`217`	`218`
`218`	`219`	`template <typename A>`