File indexing completed on 2024-04-28 16:01:31

 /******************************************************************************
  * This file is part of the libqgit2 library
  * Copyright (c) 2012 Laszlo Papp <djszapi@archlinux.us>
  * Copyright (C) 2013 Leonardo Giordani
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #ifndef LIBQGIT2_CONFIG_H
 #define LIBQGIT2_CONFIG_H
 
 #include <QtCore/QVariant>
 
 #include "git2.h"
 
 #include "libqgit2_export.h"
 
 #include "qgitrepository.h"
 
 namespace LibQGit2
 {
     /**
       * @brief Represents the git configuration file.
       *
       * @ingroup LibQGit2
       * @{
       */
     class LIBQGIT2_EXPORT Config
     {
     public:
         /**
           * Default constructor to create a new configuration object.
           *
           * @param cfg when given, the instance is used instead of creating a new one
           */
         Config(git_config *cfg = 0);
         Config(const Config &other);
         virtual ~Config();
 
         /**
           * Creates a new configuration object and adds the global Git configuration when found.
           * Otherwise an empty configuration object is created.
           *
           * @return the new instance
           */
         static Config fromGlobalConfig();
 
         /**
           * Appends a config file with the given access priority.
           *
           * @param path the absolute path to the config file
           * @param priority the access priority; values with higher priority are accessed first
           * @param repo optional repository to allow parsing of conditional includes
           * @param force replace config file at the given priority level
           *
           * @return true on success
           */
         bool append(const QString& path, git_config_level_t level, const Repository &repo = Repository(), bool force = false);
 
         /**
           * Reads a single value from the configuration.
           *
           * @return the value as QVariant or an empty QVariant instance
           */
         QVariant value(const QString &key, const QVariant &defaultValue = QVariant()) const;
 
         /**
           * Writes a value in the configuration with the highest priority.
           *
           * @param key the name of the value to write
           * @param value the value
           *
           * @todo handle the QVariant type correctly
           */
         void setValue(const QString &key, const QVariant &value);
 
         /**
           * Remove a value from the configuration.
           *
           * @param key the name for the value to remove
           */
         void remove(const QString &key);
 
     public:
         /**
           * Searches for the global configuration file located in $HOME.
           * @see git_config_find_global
           */
         static QString findGlobal();
 
         /**
           * Searches for the system configuration file.
           * @see git_config_find_system
           */
         static QString findSystem();
 
     private:
         git_config *    d; //!< internal pointer to the libgit2 config instance
     };
 
     /**@}*/
 }
 
 #endif // LIBQGIT2_CONFIG_H