flang/unittests/Runtime/Format.cpp

   1 //===-- flang/unittests/Runtime/Format.cpp ----------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "CrashHandlerFixture.h"
  10 #include "../runtime/connection.h"
  11 #include "../runtime/format-implementation.h"
  12 #include "../runtime/io-error.h"
  13 #include <optional>
  14 #include <string>
  15 #include <tuple>
  16 #include <vector>
  17
  18 using namespace Fortran::runtime;
  19 using namespace Fortran::runtime::io;
  20 using namespace std::literals::string_literals;
  21
  22 using ResultsTy = std::vector<std::string>;
  23
  24 // A test harness context for testing FormatControl
  25 class TestFormatContext : public IoErrorHandler {
  26 public:
  27   using CharType = char;
  28   TestFormatContext() : IoErrorHandler{"format.cpp", 1} {}
  29   bool Emit(const char *, std::size_t, std::size_t = 0);
  30   bool AdvanceRecord(int = 1);
  31   void HandleRelativePosition(std::int64_t);
  32   void HandleAbsolutePosition(std::int64_t);
  33   void Report(const std::optional<DataEdit> &);
  34   ResultsTy results;
  35   MutableModes &mutableModes() { return mutableModes_; }
  36   ConnectionState &GetConnectionState() { return connectionState_; }
  37
  38 private:
  39   MutableModes mutableModes_;
  40   ConnectionState connectionState_;
  41 };
  42
  43 bool TestFormatContext::Emit(const char *s, std::size_t len, std::size_t) {
  44   std::string str{s, len};
  45   results.push_back("'"s + str + '\'');
  46   return true;
  47 }
  48
  49 bool TestFormatContext::AdvanceRecord(int n) {
  50   while (n-- > 0) {
  51     results.emplace_back("/");
  52   }
  53   return true;
  54 }
  55
  56 void TestFormatContext::HandleAbsolutePosition(std::int64_t n) {
  57   results.push_back("T"s + std::to_string(n));
  58 }
  59
  60 void TestFormatContext::HandleRelativePosition(std::int64_t n) {
  61   if (n < 0) {
  62     results.push_back("TL"s + std::to_string(-n));
  63   } else {
  64     results.push_back(std::to_string(n) + 'X');
  65   }
  66 }
  67
  68 void TestFormatContext::Report(const std::optional<DataEdit> &edit) {
  69   if (edit) {
  70     std::string str{edit->descriptor};
  71     if (edit->repeat != 1) {
  72       str = std::to_string(edit->repeat) + '*' + str;
  73     }
  74     if (edit->variation) {
  75       str += edit->variation;
  76     }
  77     if (edit->width) {
  78       str += std::to_string(*edit->width);
  79     }
  80     if (edit->digits) {
  81       str += "."s + std::to_string(*edit->digits);
  82     }
  83     if (edit->expoDigits) {
  84       str += "E"s + std::to_string(*edit->expoDigits);
  85     }
  86     // modes?
  87     results.push_back(str);
  88   } else {
  89     results.push_back("(nullopt)"s);
  90   }
  91 }
  92
  93 struct FormatTests : public CrashHandlerFixture {};
  94
  95 TEST(FormatTests, FormatStringTraversal) {
  96
  97   using ParamsTy = std::tuple<int, const char *, ResultsTy, int>;
  98
  99   static const std::vector<ParamsTy> params{
 100       {1, "('PI=',F9.7)", ResultsTy{"'PI='", "F9.7"}, 1},
 101       {1, "(3HPI=F9.7)", ResultsTy{"'PI='", "F9.7"}, 1},
 102       {1, "(3HPI=/F9.7)", ResultsTy{"'PI='", "/", "F9.7"}, 1},
 103       {2, "('PI=',F9.7)", ResultsTy{"'PI='", "F9.7", "/", "'PI='", "F9.7"}, 1},
 104       {2, "(2('PI=',F9.7),'done')",
 105           ResultsTy{"'PI='", "F9.7", "'PI='", "F9.7", "'done'"}, 1},
 106       {2, "(3('PI=',F9.7,:),'tooFar')",
 107           ResultsTy{"'PI='", "F9.7", "'PI='", "F9.7"}, 1},
 108       {2, "(*('PI=',F9.7,:))", ResultsTy{"'PI='", "F9.7", "'PI='", "F9.7"}, 1},
 109       {1, "(3F9.7)", ResultsTy{"2*F9.7"}, 2},
 110   };
 111
 112   for (const auto &[n, format, expect, repeat] : params) {
 113     TestFormatContext context;
 114     FormatControl<decltype(context)> control{
 115         context, format, std::strlen(format)};
 116
 117     for (auto i{0}; i < n; i++) {
 118       context.Report(/*edit=*/control.GetNextDataEdit(context, repeat));
 119     }
 120     control.Finish(context);
 121
 122     auto iostat{context.GetIoStat()};
 123     ASSERT_EQ(iostat, 0) << "Expected iostat == 0, but GetIoStat() == "
 124                          << iostat;
 125
 126     // Create strings of the expected/actual results for printing errors
 127     std::string allExpectedResults{""}, allActualResults{""};
 128     for (const auto &res : context.results) {
 129       allActualResults += " "s + res;
 130     }
 131     for (const auto &res : expect) {
 132       allExpectedResults += " "s + res;
 133     }
 134
 135     const auto &results = context.results;
 136     ASSERT_EQ(expect, results) << "Expected '" << allExpectedResults
 137                                << "' but got '" << allActualResults << "'";
 138   }
 139 }
 140
 141 struct InvalidFormatFailure : CrashHandlerFixture {};
 142
 143 TEST(InvalidFormatFailure, ParenMismatch) {
 144   static constexpr const char *format{"("};
 145   static constexpr int repeat{1};
 146
 147   TestFormatContext context;
 148   FormatControl<decltype(context)> control{
 149       context, format, std::strlen(format)};
 150
 151   ASSERT_DEATH(
 152       context.Report(/*edit=*/control.GetNextDataEdit(context, repeat)),
 153       R"(FORMAT missing at least one '\)')");
 154 }
 155
 156 TEST(InvalidFormatFailure, MissingPrecision) {
 157   static constexpr const char *format{"(F9.)"};
 158   static constexpr int repeat{1};
 159
 160   TestFormatContext context;
 161   FormatControl<decltype(context)> control{
 162       context, format, std::strlen(format)};
 163
 164   ASSERT_DEATH(
 165       context.Report(/*edit=*/control.GetNextDataEdit(context, repeat)),
 166       R"(Invalid FORMAT: integer expected at '\)')");
 167 }
 168
 169 TEST(InvalidFormatFailure, MissingFormatWidth) {
 170   static constexpr const char *format{"(F.9)"};
 171   static constexpr int repeat{1};
 172
 173   TestFormatContext context;
 174   FormatControl<decltype(context)> control{
 175       context, format, std::strlen(format)};
 176
 177   ASSERT_DEATH(
 178       context.Report(/*edit=*/control.GetNextDataEdit(context, repeat)),
 179       "Invalid FORMAT: integer expected at '.'");
 180 }