# configitems.py - centralized declaration of configuration option

#

#  Copyright 2017 Pierre-Yves David <pierre-yves.david@octobus.net>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

from __future__ import absolute_import

import functools

import re

from . import (

    encoding,

    error,

)

def loadconfigtable(ui, extname, configtable):

    """update config item known to the ui with the extension ones"""

    for section, items in configtable.items():

        knownitems = ui._knownconfig.setdefault(section, itemregister())

        knownkeys = set(knownitems)

        newkeys = set(items)

        for key in sorted(knownkeys & newkeys):

            msg = "extension '%s' overwrite config item '%s.%s'"

            msg %= (extname, section, key)

            ui.develwarn(msg, config='warn-config')

        knownitems.update(items)

class configitem(object):

    """represent a known config item

    :section: the official config section where to find this item,

       :name: the official name within the section,

    :default: default value for this item,

    :alias: optional list of tuples as alternatives,

    :generic: this is a generic definition, match name using regular expression.

    """

    def __init__(self, section, name, default=None, alias=(),

                 generic=False, priority=0):

        self.section = section

        self.name = name

        self.default = default

        self.alias = list(alias)

        self.generic = generic

        self.priority = priority

        self._re = None

        if generic:

            self._re = re.compile(self.name)

class itemregister(dict):

    """A specialized dictionary that can handle wild-card selection"""

    def __init__(self):

        super(itemregister, self).__init__()

        self._generics = set()

    def update(self, other):

        super(itemregister, self).update(other)

        self._generics.update(other._generics)

    def __setitem__(self, key, item):

        super(itemregister, self).__setitem__(key, item)

        if item.generic:

            self._generics.add(item)

    def get(self, key):

        baseitem = super(itemregister, self).get(key)

        if baseitem is not None and not baseitem.generic:

            return baseitem

        # search for a matching generic item

        generics = sorted(self._generics, key=(lambda x: (x.priority, x.name)))

        for item in generics:

            # we use 'match' instead of 'search' to make the matching simpler

            # for people unfamiliar with regular expression. Having the match

            # rooted to the start of the string will produce less surprising

            # result for user writing simple regex for sub-attribute.

            #

            # For example using "color\..*" match produces an unsurprising

            # result, while using search could suddenly match apparently

            # unrelated configuration that happens to contains "color."

            # anywhere. This is a tradeoff where we favor requiring ".*" on

            # some match to avoid the need to prefix most pattern with "^".

            # The "^" seems more error prone.

            if item._re.match(key):

                return item

        return None

coreitems = {}

def _register(configtable, *args, **kwargs):

    item = configitem(*args, **kwargs)

    section = configtable.setdefault(item.section, itemregister())

    if item.name in section:

        msg = "duplicated config item registration for '%s.%s'"

        raise error.ProgrammingError(msg % (item.section, item.name))

    section[item.name] = item

# special value for case where the default is derived from other values

dynamicdefault = object()

# Registering actual config items

def getitemregister(configtable):

    f = functools.partial(_register, configtable)

    # export pseudo enum as configitem.*

    f.dynamicdefault = dynamicdefault

    return f

coreconfigitem = getitemregister(coreitems)

coreconfigitem('alias', '.*',

    default=None,

    generic=True,

)

coreconfigitem('annotate', 'nodates',

    default=False,

)

coreconfigitem('annotate', 'showfunc',

    default=False,

)

coreconfigitem('annotate', 'unified',

    default=None,

)

coreconfigitem('annotate', 'git',

    default=False,

)

coreconfigitem('annotate', 'ignorews',

    default=False,

)

coreconfigitem('annotate', 'ignorewsamount',

    default=False,

)

coreconfigitem('annotate', 'ignoreblanklines',

    default=False,

)

coreconfigitem('annotate', 'ignorewseol',

    default=False,

)

coreconfigitem('annotate', 'nobinary',

    default=False,

)

coreconfigitem('annotate', 'noprefix',

    default=False,

)

coreconfigitem('auth', 'cookiefile',

    default=None,

)

# bookmarks.pushing: internal hack for discovery

coreconfigitem('bookmarks', 'pushing',

    default=list,

)

# bundle.mainreporoot: internal hack for bundlerepo

coreconfigitem('bundle', 'mainreporoot',

    default='',

)

# bundle.reorder: experimental config

coreconfigitem('bundle', 'reorder',

    default='auto',

)

coreconfigitem('censor', 'policy',

    default='abort',

)

coreconfigitem('chgserver', 'idletimeout',

    default=3600,

)

coreconfigitem('chgserver', 'skiphash',

    default=False,

)

coreconfigitem('cmdserver', 'log',

    default=None,

)

coreconfigitem('color', '.*',

    default=None,

    generic=True,

)

coreconfigitem('color', 'mode',

    default='auto',

)

coreconfigitem('color', 'pagermode',

    default=dynamicdefault,

)

coreconfigitem('commands', 'show.aliasprefix',

    default=list,

)

coreconfigitem('commands', 'status.relative',

    default=False,

)

coreconfigitem('commands', 'status.skipstates',

    default=[],

)

coreconfigitem('commands', 'status.verbose',

    default=False,

)

coreconfigitem('commands', 'update.check',

    default=None,

    # Deprecated, remove after 4.4 release

    alias=[('experimental', 'updatecheck')]

)

coreconfigitem('commands', 'update.requiredest',

    default=False,

)

coreconfigitem('committemplate', '.*',

    default=None,

    generic=True,

)

coreconfigitem('convert', 'cvsps.cache',

    default=True,

)

coreconfigitem('convert', 'cvsps.fuzz',

    default=60,

)

coreconfigitem('convert', 'cvsps.logencoding',

    default=None,

)

coreconfigitem('convert', 'cvsps.mergefrom',

    default=None,

)

coreconfigitem('convert', 'cvsps.mergeto',

    default=None,

)

coreconfigitem('convert', 'git.committeractions',

    default=lambda: ['messagedifferent'],

)

coreconfigitem('convert', 'git.extrakeys',

    default=list,

)

coreconfigitem('convert', 'git.findcopiesharder',

    default=False,

)

coreconfigitem('convert', 'git.remoteprefix',

    default='remote',

)

coreconfigitem('convert', 'git.renamelimit',

    default=400,

)

coreconfigitem('convert', 'git.saverev',

    default=True,

)

coreconfigitem('convert', 'git.similarity',

    default=50,

)

coreconfigitem('convert', 'git.skipsubmodules',

    default=False,

)

coreconfigitem('convert', 'hg.clonebranches',

    default=False,

)

coreconfigitem('convert', 'hg.ignoreerrors',

    default=False,

)

coreconfigitem('convert', 'hg.revs',

    default=None,

)

coreconfigitem('convert', 'hg.saverev',

    default=False,

)

coreconfigitem('convert', 'hg.sourcename',

    default=None,

)

coreconfigitem('convert', 'hg.startrev',

    default=None,

)

coreconfigitem('convert', 'hg.tagsbranch',

    default='default',

)

coreconfigitem('convert', 'hg.usebranchnames',

    default=True,

)

coreconfigitem('convert', 'ignoreancestorcheck',

    default=False,

)

coreconfigitem('convert', 'localtimezone',

    default=False,

)

coreconfigitem('convert', 'p4.encoding',

    default=dynamicdefault,

)

coreconfigitem('convert', 'p4.startrev',

    default=0,

)

coreconfigitem('convert', 'skiptags',

    default=False,

)

coreconfigitem('convert', 'svn.debugsvnlog',

    default=True,

)

coreconfigitem('convert', 'svn.trunk',

    default=None,

)

coreconfigitem('convert', 'svn.tags',

    default=None,

)

coreconfigitem('convert', 'svn.branches',

    default=None,

)

coreconfigitem('convert', 'svn.startrev',

    default=0,

)

coreconfigitem('debug', 'dirstate.delaywrite',

    default=0,

)

coreconfigitem('defaults', '.*',

    default=None,

    generic=True,

)

coreconfigitem('devel', 'all-warnings',

    default=False,

)

coreconfigitem('devel', 'bundle2.debug',

    default=False,

)

coreconfigitem('devel', 'cache-vfs',

    default=None,

)

coreconfigitem('devel', 'check-locks',

    default=False,

)

coreconfigitem('devel', 'check-relroot',

    default=False,

)

coreconfigitem('devel', 'default-date',

    default=None,

)

coreconfigitem('devel', 'deprec-warn',

    default=False,

)

coreconfigitem('devel', 'disableloaddefaultcerts',

    default=False,

)

coreconfigitem('devel', 'warn-empty-changegroup',

    default=False,

)

coreconfigitem('devel', 'legacy.exchange',

    default=list,

)

coreconfigitem('devel', 'servercafile',

    default='',

)

coreconfigitem('devel', 'serverexactprotocol',

    default='',

)

coreconfigitem('devel', 'serverrequirecert',

    default=False,

)

coreconfigitem('devel', 'strip-obsmarkers',

    default=True,

)

coreconfigitem('devel', 'warn-config',

    default=None,

)

coreconfigitem('devel', 'warn-config-default',

    default=None,

)

coreconfigitem('devel', 'user.obsmarker',

    default=None,

)

coreconfigitem('devel', 'warn-config-unknown',

    default=None,

)

coreconfigitem('devel', 'debug.peer-request',

    default=False,

)

coreconfigitem('diff', 'nodates',

    default=False,

)

coreconfigitem('diff', 'showfunc',

    default=False,

)

coreconfigitem('diff', 'unified',

    default=None,

)

coreconfigitem('diff', 'git',

    default=False,

)

coreconfigitem('diff', 'ignorews',

    default=False,

)

coreconfigitem('diff', 'ignorewsamount',

    default=False,

)

coreconfigitem('diff', 'ignoreblanklines',

    default=False,

)

coreconfigitem('diff', 'ignorewseol',

    default=False,

)

coreconfigitem('diff', 'nobinary',

    default=False,

)

coreconfigitem('diff', 'noprefix',

    default=False,