[pim/kcalutils] /: Clean up non-functional extensiveDisplayStr calendar pointer overload

Volker Krause <[email protected]>
Newsgroups gmane.comp.kde.cvs
Message-ID <[email protected]>
Git commit bf03f8575a5acf0b4f5161e53f37cb12253233be by Volker Krause.
Committed on 27/07/2026 at 15:33.
Pushed by vkrause into branch 'master'.

Clean up non-functional extensiveDisplayStr calendar pointer overload

All that does is ultimately producing an empty string for the calendar
name.

M  +4    -4    autotests/testincidenceformatter.cpp
M  +19   -69   src/incidenceformatter.cpp
M  +0    -21   src/incidenceformatter.h

https://invent.kde.org/pim/kcalutils/-/commit/bf03f8575a5acf0b4f5161e53f37cb12253233be

diff --git a/autotests/testincidenceformatter.cpp b/autotests/testincidenceformatter.cpp
index a68d6409f..9b6a1e4a1 100644
--- a/autotests/testincidenceformatter.cpp
+++ b/autotests/testincidenceformatter.cpp
@@ -289,7 +289,7 @@ void IncidenceFormatterTest::testDisplayViewFormatEvent()
     const auto events = calendar->events();
     QCOMPARE(events.size(), 1);
 
-    const QString html = IncidenceFormatter::extensiveDisplayStr(calendar, events[0]);
+    const QString html = IncidenceFormatter::extensiveDisplayStr(QString(), events[0]);
 
     QVERIFY(validateHtml(name, html));
     QVERIFY(compareHtml(name));
@@ -315,7 +315,7 @@ void IncidenceFormatterTest::testDisplayViewFormatTodo()
     const auto todos = calendar->todos();
     QCOMPARE(todos.size(), 1);
 
-    const QString html = IncidenceFormatter::extensiveDisplayStr(calendar, todos[0]);
+    const QString html = IncidenceFormatter::extensiveDisplayStr(QString(), todos[0]);
 
     QVERIFY(validateHtml(name, html));
     QVERIFY(compareHtml(name));
@@ -340,7 +340,7 @@ void IncidenceFormatterTest::testDisplayViewFormatJournal()
     const auto journals = calendar->journals();
     QCOMPARE(journals.size(), 1);
 
-    const QString html = IncidenceFormatter::extensiveDisplayStr(calendar, journals[0]);
+    const QString html = IncidenceFormatter::extensiveDisplayStr(QString(), journals[0]);
 
     QVERIFY(validateHtml(name, html));
     QVERIFY(compareHtml(name));
@@ -370,7 +370,7 @@ void IncidenceFormatterTest::testDisplayViewFreeBusy()
     const KCalendarCore::FreeBusy::Ptr freeBusy = format.parseFreeBusy(QString::fromUtf8(fbData));
     QVERIFY(freeBusy);
 
-    const QString html = IncidenceFormatter::extensiveDisplayStr(calendar, freeBusy);
+    const QString html = IncidenceFormatter::extensiveDisplayStr(QString(), freeBusy);
 
     QVERIFY(validateHtml(name, html));
     QVERIFY(compareHtml(name));
diff --git a/src/incidenceformatter.cpp b/src/incidenceformatter.cpp
index 3c9ec3788..39eec8b6e 100644
--- a/src/incidenceformatter.cpp
+++ b/src/incidenceformatter.cpp
@@ -282,7 +282,7 @@ struct IncidenceNameAndUid {
     return displayViewFormatPerson(email, name, uid, rsvpStatusIconName(status));
 }
 
-[[nodiscard]] static bool incOrganizerOwnsCalendar([[maybe_unused]] const Calendar::Ptr &calendar, const Incidence::Ptr &incidence)
+[[nodiscard]] static bool incOrganizerOwnsCalendar(const Incidence::Ptr &incidence)
 {
     // PORTME!  Look at e35's CalHelper::incOrganizerOwnsCalendar
 
@@ -431,7 +431,7 @@ struct IncidenceNameAndUid {
     return incidenceData;
 }
 
-[[nodiscard]] static QString displayViewFormatEvent(const Calendar::Ptr &calendar, const QString &sourceName, const Event::Ptr &event, QDate date)
+[[nodiscard]] static QString displayViewFormatEvent(const QString &sourceName, const Event::Ptr &event, QDate date)
 {
     if (!event) {
         return QString();
@@ -439,7 +439,7 @@ struct IncidenceNameAndUid {
 
     QVariantHash incidence = incidenceTemplateHeader(event);
 
-    incidence[QStringLiteral("calendar")] = calendar ? resourceString(calendar, event) : sourceName;
+    incidence[QStringLiteral("calendar")] = sourceName;
     const QString richLocation = event->richLocation();
     if (richLocation.startsWith(QLatin1StringView("http:/")) || richLocation.startsWith(QLatin1StringView("https:/"))) {
         incidence[QStringLiteral("location")] = QStringLiteral("<a href=\"%1\">%1</a>").arg(richLocation);
@@ -492,7 +492,7 @@ struct IncidenceNameAndUid {
     }
     incidence[QStringLiteral("reminders")] = remVars;
     incidence[QStringLiteral("organizer")] = displayViewFormatOrganizer(event);
-    const bool showStatus = incOrganizerOwnsCalendar(calendar, event);
+    const bool showStatus = incOrganizerOwnsCalendar(event);
     incidence[QStringLiteral("chair")] = displayViewFormatAttendeeRoleList(event, Attendee::Chair, showStatus);
     incidence[QStringLiteral("requiredParticipants")] = displayViewFormatAttendeeRoleList(event, Attendee::ReqParticipant, showStatus);
     incidence[QStringLiteral("optionalParticipants")] = displayViewFormatAttendeeRoleList(event, Attendee::OptParticipant, showStatus);
@@ -513,7 +513,7 @@ struct IncidenceNameAndUid {
     return GrantleeTemplateManager::instance()->render(QStringLiteral("org.kde.pim/kcalutils/event.html"), incidence);
 }
 
-[[nodiscard]] static QString displayViewFormatTodo(const Calendar::Ptr &calendar, const QString &sourceName, const Todo::Ptr &todo, QDate ocurrenceDueDate)
+[[nodiscard]] static QString displayViewFormatTodo(const QString &sourceName, const Todo::Ptr &todo, QDate ocurrenceDueDate)
 {
     if (!todo) {
         qCDebug(KCALUTILS_LOG) << "IncidenceFormatter::displayViewFormatTodo was called without to-do, quitting";
@@ -522,7 +522,7 @@ struct IncidenceNameAndUid {
 
     QVariantHash incidence = incidenceTemplateHeader(todo);
 
-    incidence[QStringLiteral("calendar")] = calendar ? resourceString(calendar, todo) : sourceName;
+    incidence[QStringLiteral("calendar")] = sourceName;
     incidence[QStringLiteral("location")] = todo->richLocation();
 
     const bool hastStartDate = todo->hasStartDate();
@@ -578,7 +578,7 @@ struct IncidenceNameAndUid {
     incidence[QStringLiteral("reminders")] = remVars;
 
     incidence[QStringLiteral("organizer")] = displayViewFormatOrganizer(todo);
-    const bool showStatus = incOrganizerOwnsCalendar(calendar, todo);
+    const bool showStatus = incOrganizerOwnsCalendar(todo);
     incidence[QStringLiteral("chair")] = displayViewFormatAttendeeRoleList(todo, Attendee::Chair, showStatus);
     incidence[QStringLiteral("requiredParticipants")] = displayViewFormatAttendeeRoleList(todo, Attendee::ReqParticipant, showStatus);
     incidence[QStringLiteral("optionalParticipants")] = displayViewFormatAttendeeRoleList(todo, Attendee::OptParticipant, showStatus);
@@ -604,14 +604,14 @@ struct IncidenceNameAndUid {
     return GrantleeTemplateManager::instance()->render(QStringLiteral("org.kde.pim/kcalutils/todo.html"), incidence);
 }
 
-[[nodiscard]] static QString displayViewFormatJournal(const Calendar::Ptr &calendar, const QString &sourceName, const Journal::Ptr &journal)
+[[nodiscard]] static QString displayViewFormatJournal(const QString &sourceName, const Journal::Ptr &journal)
 {
     if (!journal) {
         return QString();
     }
 
     QVariantHash incidence = incidenceTemplateHeader(journal);
-    incidence[QStringLiteral("calendar")] = calendar ? resourceString(calendar, journal) : sourceName;
+    incidence[QStringLiteral("calendar")] = sourceName;
     incidence[QStringLiteral("date")] = journal->dtStart().toLocalTime();
     incidence[QStringLiteral("description")] = displayViewFormatDescription(journal);
     QVariantList catVars;
@@ -627,8 +627,7 @@ struct IncidenceNameAndUid {
     return GrantleeTemplateManager::instance()->render(QStringLiteral("org.kde.pim/kcalutils/journal.html"), incidence);
 }
 
-[[nodiscard]] static QString
-displayViewFormatFreeBusy([[maybe_unused]] const Calendar::Ptr &calendar, [[maybe_unused]] const QString &sourceName, const FreeBusy::Ptr &fb)
+[[nodiscard]] static QString displayViewFormatFreeBusy([[maybe_unused]] const QString &sourceName, const FreeBusy::Ptr &fb)
 {
     if (!fb) {
         return QString();
@@ -688,22 +687,9 @@ displayViewFormatFreeBusy([[maybe_unused]] const Calendar::Ptr &calendar, [[mayb
 class KCalUtils::IncidenceFormatter::EventViewerVisitor : public Visitor
 {
 public:
-    EventViewerVisitor()
-        : mCalendar(nullptr)
-    {
-    }
-
+    EventViewerVisitor() = default;
     ~EventViewerVisitor() override;
 
-    bool act(const Calendar::Ptr &calendar, const IncidenceBase::Ptr &incidence, QDate date)
-    {
-        mCalendar = calendar;
-        mSourceName.clear();
-        mDate = date;
-        mResult = QLatin1StringView("");
-        return incidence->accept(*this, incidence);
-    }
-
     bool act(const QString &sourceName, const IncidenceBase::Ptr &incidence, QDate date)
     {
         mSourceName = sourceName;
@@ -720,53 +706,36 @@ public:
 protected:
     bool visit(const Event::Ptr &event) override
     {
-        mResult = displayViewFormatEvent(mCalendar, mSourceName, event, mDate);
+        mResult = displayViewFormatEvent(mSourceName, event, mDate);
         return !mResult.isEmpty();
     }
 
     bool visit(const Todo::Ptr &todo) override
     {
-        mResult = displayViewFormatTodo(mCalendar, mSourceName, todo, mDate);
+        mResult = displayViewFormatTodo(mSourceName, todo, mDate);
         return !mResult.isEmpty();
     }
 
     bool visit(const Journal::Ptr &journal) override
     {
-        mResult = displayViewFormatJournal(mCalendar, mSourceName, journal);
+        mResult = displayViewFormatJournal(mSourceName, journal);
         return !mResult.isEmpty();
     }
 
     bool visit(const FreeBusy::Ptr &fb) override
     {
-        mResult = displayViewFormatFreeBusy(mCalendar, mSourceName, fb);
+        mResult = displayViewFormatFreeBusy(mSourceName, fb);
         return !mResult.isEmpty();
     }
 
 protected:
-    Calendar::Ptr mCalendar;
     QString mSourceName;
     QDate mDate;
     QString mResult;
 };
 //@endcond
 
-EventViewerVisitor::~EventViewerVisitor()
-{
-}
-
-QString IncidenceFormatter::extensiveDisplayStr(const Calendar::Ptr &calendar, const IncidenceBase::Ptr &incidence, QDate date)
-{
-    if (!incidence) {
-        return QString();
-    }
-
-    EventViewerVisitor v;
-    if (v.act(calendar, incidence, date)) {
-        return v.result();
-    } else {
-        return QString();
-    }
-}
+EventViewerVisitor::~EventViewerVisitor() = default;
 
 QString IncidenceFormatter::extensiveDisplayStr(const QString &sourceName, const IncidenceBase::Ptr &incidence, QDate date)
 {
@@ -2334,16 +2303,6 @@ class KCalUtils::IncidenceFormatter::ToolTipVisitor : public Visitor
 public:
     ToolTipVisitor() = default;
 
-    bool act(const Calendar::Ptr &calendar, const IncidenceBase::Ptr &incidence, QDate date = QDate(), bool richText = true)
-    {
-        mCalendar = calendar;
-        mLocation.clear();
-        mDate = date;
-        mRichText = richText;
-        mResult = QLatin1StringView("");
-        return incidence ? incidence->accept(*this, incidence) : false;
-    }
-
     bool act(const QString &location, const IncidenceBase::Ptr &incidence, QDate date = QDate(), bool richText = true)
     {
         mLocation = location;
@@ -2372,7 +2331,6 @@ protected:
     [[nodiscard]] QString generateToolTip(const Incidence::Ptr &incidence, const QString &dtRangeText);
 
 protected:
-    Calendar::Ptr mCalendar;
     QString mLocation;
     QDate mDate;
     bool mRichText = true;
@@ -2605,7 +2563,7 @@ bool IncidenceFormatter::ToolTipVisitor::visit(const FreeBusy::Ptr &fb)
     return tmpStr;
 }
 
-[[nodiscard]] static QString tooltipFormatAttendees(const Calendar::Ptr &calendar, const Incidence::Ptr &incidence)
+[[nodiscard]] static QString tooltipFormatAttendees(const Incidence::Ptr &incidence)
 {
     QString tmpStr;
     QString str;
@@ -2619,7 +2577,7 @@ bool IncidenceFormatter::ToolTipVisitor::visit(const FreeBusy::Ptr &fb)
 
     // Show the attendee status if the incidence's organizer owns the resource calendar,
     // which means they are running the show and have all the up-to-date response info.
-    const bool showStatus = attendeeCount > 0 && incOrganizerOwnsCalendar(calendar, incidence);
+    const bool showStatus = attendeeCount > 0 && incOrganizerOwnsCalendar(incidence);
 
     // Add "chair"
     str = tooltipFormatAttendeeRoleList(incidence, Attendee::Chair, showStatus);
@@ -2666,9 +2624,6 @@ QString IncidenceFormatter::ToolTipVisitor::generateToolTip(const Incidence::Ptr
     tmp += QLatin1StringView("<hr>");
 
     QString calStr = mLocation;
-    if (mCalendar) {
-        calStr = resourceString(mCalendar, incidence);
-    }
     if (!calStr.isEmpty()) {
         tmp += QLatin1StringView("<i>") + i18n("Calendar:") + QLatin1StringView("</i>") + QLatin1StringView("&nbsp;");
         tmp += calStr;
@@ -2737,7 +2692,7 @@ QString IncidenceFormatter::ToolTipVisitor::generateToolTip(const Incidence::Ptr
         }
     }
 
-    const QString attendees = tooltipFormatAttendees(mCalendar, incidence);
+    const QString attendees = tooltipFormatAttendees(incidence);
     if (!attendees.isEmpty()) {
         if (needAnHorizontalLine) {
             tmp += QLatin1StringView("<hr>");
@@ -3357,11 +3312,6 @@ QString IncidenceFormatter::dateTimeToString(const QDateTime &date, bool allDay,
     return QLocale().toString(date.toLocalTime(), (shortfmt ? QLocale::ShortFormat : QLocale::LongFormat));
 }
 
-QString IncidenceFormatter::resourceString([[maybe_unused]] const Calendar::Ptr &calendar, [[maybe_unused]] const Incidence::Ptr &incidence)
-{
-    return QString();
-}
-
 static QString secs2Duration(qint64 secs)
 {
     QString tmp;
diff --git a/src/incidenceformatter.h b/src/incidenceformatter.h
index 63e8ad281..22e94b373 100644
--- a/src/incidenceformatter.h
+++ b/src/incidenceformatter.h
@@ -101,19 +101,6 @@ namespace IncidenceFormatter
 */
 KCALUTILS_EXPORT QString toolTipStr(const QString &sourceName, const KCalendarCore::IncidenceBase::Ptr &incidence, QDate date = QDate(), bool richText = true);
 
-/*!
-  Create a RichText QString representation of an Incidence in a nice format
-  suitable for using in a viewer widget.
-  All dates and times are converted to local time for display.
-  \a calendar is a pointer to the Calendar that owns the specified Incidence.
-  \a incidence is a pointer to the Incidence to be formatted.
-  \a date is the QDate for which the string representation should be computed;
-  used mainly for recurring incidences.
-*/
-KCALUTILS_EXPORT QString extensiveDisplayStr(const KCalendarCore::Calendar::Ptr &calendar,
-                                             const KCalendarCore::IncidenceBase::Ptr &incidence,
-                                             QDate date = QDate());
-
 /*!
   Create a RichText QString representation of an Incidence in a nice format
   suitable for using in a viewer widget.
@@ -205,14 +192,6 @@ KCALUTILS_EXPORT QString formatStartEnd(const QDateTime &start, const QDateTime
 */
 KCALUTILS_EXPORT QString dateTimeToString(const QDateTime &date, bool dateOnly = false, bool shortfmt = true);
 
-/*!
-  Returns a Calendar Resource label name for the specified Incidence.
-  \param calendar a pointer to the Calendar
-  \param incidence a pointer to the Incidence
-  \return the resource string
-*/
-KCALUTILS_EXPORT QString resourceString(const KCalendarCore::Calendar::Ptr &calendar, const KCalendarCore::Incidence::Ptr &incidence);
-
 /*!
   Returns a duration string computed for the specified Incidence.
   \param incidence a pointer to the Incidence
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.