File indexing completed on 2024-05-12 05:52:07

 /*
     SPDX-FileCopyrightText: 2005 Christoph Cullmann <cullmann@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "kateprivate_export.h"
 
 #include <QDateTime>
 #include <QExplicitlySharedDataPointer>
 #include <QString>
 
 #include <memory>
 
 class KConfig;
 
 class KATE_PRIVATE_EXPORT KateSession : public QSharedData
 {
 public:
     /**
      * Define a Shared-Pointer type
      */
     typedef QExplicitlySharedDataPointer<KateSession> Ptr;
 
 public:
     /**
      * session name
      * @return name for this session
      */
     const QString &name() const
     {
         return m_name;
     }
 
     /**
      * session config
      * on first access, will create the config object, delete will be done automagic
      * return 0 if we have no file to read config from atm
      * @return correct KConfig, never null
      * @note never delete configRead(), because the return value might be
      *       KSharedConfig::openConfig(). Only delete the member variables directly.
      */
     KConfig *config();
 
     /**
      * count of documents in this session
      * @return documents count
      */
     unsigned int documents();
 
     /**
      * @return true if this is anonymous/new session
      */
     bool isAnonymous() const
     {
         return m_anonymous;
     }
 
     /**
      * @return path to session file
      */
     const QString &file() const;
 
     /**
      * returns last save time of this session
      */
     const QDateTime &timestamp() const
     {
         return m_timestamp;
     }
 
     /**
      * Factories
      */
 public:
     static KateSession::Ptr create(const QString &file, const QString &name);
     static KateSession::Ptr createFrom(const KateSession::Ptr &session, const QString &file, const QString &name);
     static KateSession::Ptr createAnonymous(const QString &file);
     static KateSession::Ptr createAnonymousFrom(const KateSession::Ptr &session, const QString &file);
 
     static bool compareByName(const KateSession::Ptr &s1, const KateSession::Ptr &s2);
     static bool compareByTimeDesc(const KateSession::Ptr &s1, const KateSession::Ptr &s2);
 
 private:
     friend class KateSessionManager;
     friend class KateSessionTest;
     /**
      * set session name
      */
     void setName(const QString &name);
 
     /**
      * set's new session file to @filename
      */
     void setFile(const QString &filename);
 
     /**
      * create a session from given @file
      * @param file configuration file
      * @param name name of this session
      * @param anonymous anonymous flag
      * @param config if specified, the session will copy configuration from the KConfig instead of opening the file
      */
     KateSession(const QString &file, const QString &name, const bool anonymous, const KConfig *config = nullptr);
 
 private:
     QString m_name;
     QString m_file;
     bool m_anonymous;
     std::unique_ptr<KConfig> m_config;
     QDateTime m_timestamp;
 };