File indexing completed on 2024-04-28 05:50:42

 /*
     This source file is part of Konsole, a terminal emulator.
 
     SPDX-FileCopyrightText: 2007-2008 Robert Knight <robertknight@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef KEYBOARDTRANSLATOR_MANAGER_H
 #define KEYBOARDTRANSLATOR_MANAGER_H
 
 // Qt
 #include <QHash>
 #include <QStringList>
 
 // Konsole
 #include "KeyboardTranslator.h"
 
 class QIODevice;
 
 namespace Konsole
 {
 /**
  * Manages the keyboard translations available for use by terminal sessions,
  * see KeyboardTranslator.
  */
 class KeyboardTranslatorManager
 {
 public:
     /**
      * Constructs a new KeyboardTranslatorManager and loads the list of
      * available keyboard translations.
      *
      * The keyboard translations themselves are not loaded until they are
      * first requested via a call to findTranslator()
      */
     KeyboardTranslatorManager();
     ~KeyboardTranslatorManager();
 
     KeyboardTranslatorManager(const KeyboardTranslatorManager &) = delete;
     KeyboardTranslatorManager &operator=(const KeyboardTranslatorManager &) = delete;
 
     /**
      * Adds a new translator.  If a translator with the same name
      * already exists, it will be replaced by the new translator.
      *
      * TODO: More documentation.
      */
     void addTranslator(KeyboardTranslator *translator);
 
     /**
      * Deletes a translator.  Returns true on successful deletion or false otherwise.
      *
      * TODO: More documentation
      */
     bool deleteTranslator(const QString &name);
 
     /**
      * Checks whether a translator can be deleted or not (by checking if
      * the directory containing the .keytab file is writable, because one
      * can still delete a file owned by a different user if the directory
      * containing it is writable for the current user).
      */
     bool isTranslatorDeletable(const QString &name) const;
 
     /**
      * Checks whether a translator can be reset to its default values.
      * This is only applicable for translators that exist in two different
      * locations:
      *  - system-wide location which is read-only for the user (typically
      *    /usr/share/konsole/ on Linux)
      *  - writable user-specific location under the user's home directory
      *    (typically ~/.local/share/konsole on Linux)
      *
      * Resetting here basically means it deletes the translator from the
      * location under the user's home directory, then "reloads" it from
      * the system-wide location.
      */
     bool isTranslatorResettable(const QString &name) const;
 
     /** Returns the default translator for Konsole. */
     const KeyboardTranslator *defaultTranslator();
 
     /**
      * Returns the keyboard translator with the given name or 0 if no translator
      * with that name exists.
      *
      * The first time that a translator with a particular name is requested,
      * the on-disk .keytab file is loaded and parsed.
      */
     const KeyboardTranslator *findTranslator(const QString &name);
     /**
      * Returns a list of the names of available keyboard translators.
      *
      * The first time this is called, a search for available
      * translators is started.
      */
     const QStringList allTranslators();
 
     /** Returns the global KeyboardTranslatorManager instance. */
     static KeyboardTranslatorManager *instance();
 
     /** Returns the translator path */
     const QString findTranslatorPath(const QString &name) const;
 
 private:
     void findTranslators(); // locate all available translators
 
     // loads the translator with the given name
     KeyboardTranslator *loadTranslator(const QString &name);
     KeyboardTranslator *loadTranslator(QIODevice *source, const QString &name);
 
     bool saveTranslator(const KeyboardTranslator *translator);
 
     bool _haveLoadedAll;
 
     const KeyboardTranslator *_fallbackTranslator;
     QHash<QString, KeyboardTranslator *> _translators;
 };
 }
 
 #endif // KEYBOARDTRANSLATOR_MANAGER_H