# 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.

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 sorted(configtable.items()):

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

        knownkeys = set(knownitems)

        newkeys = set(items)

        for key in sorted(knownkeys & newkeys):

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

            msg %= (extname, section, key)

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

        knownitems.update(items)

class configitem:

    """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,

        experimental=False,

    ):

        self.section = section

        self.name = name

        self.default = default

        self.alias = list(alias)

        self.generic = generic

        self.priority = priority

        self.experimental = experimental

        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 = b"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)

def _registerdiffopts(section, configprefix=b''):

    coreconfigitem(

        section,

        configprefix + b'nodates',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'showfunc',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'unified',

        default=None,

    )

    coreconfigitem(

        section,

        configprefix + b'git',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'ignorews',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'ignorewsamount',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'ignoreblanklines',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'ignorewseol',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'nobinary',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'noprefix',

        default=False,

    )

    coreconfigitem(

        section,

        configprefix + b'word-diff',

        default=False,

    )

coreconfigitem(

    b'alias',

    b'.*',

    default=dynamicdefault,

    generic=True,

)

coreconfigitem(

    b'auth',

    b'cookiefile',

    default=None,

)

_registerdiffopts(section=b'annotate')

# bookmarks.pushing: internal hack for discovery

coreconfigitem(

    b'bookmarks',

    b'pushing',

    default=list,

)

# bundle.mainreporoot: internal hack for bundlerepo

coreconfigitem(

    b'bundle',

    b'mainreporoot',

    default=b'',

)

coreconfigitem(

    b'censor',

    b'policy',

    default=b'abort',

    experimental=True,

)

coreconfigitem(

    b'chgserver',

    b'idletimeout',

    default=3600,

)

coreconfigitem(

    b'chgserver',

    b'skiphash',

    default=False,

)

coreconfigitem(

    b'cmdserver',

    b'log',

    default=None,

)

coreconfigitem(

    b'cmdserver',

    b'max-log-files',

    default=7,

)

coreconfigitem(

    b'cmdserver',

    b'max-log-size',

    default=b'1 MB',

)

coreconfigitem(

    b'cmdserver',

    b'max-repo-cache',

    default=0,

    experimental=True,

)

coreconfigitem(

    b'cmdserver',

    b'message-encodings',

    default=list,

)

coreconfigitem(

    b'cmdserver',

    b'track-log',

    default=lambda: [b'chgserver', b'cmdserver', b'repocache'],

)

coreconfigitem(

    b'cmdserver',

    b'shutdown-on-interrupt',

    default=True,

)

coreconfigitem(

    b'color',

    b'.*',

    default=None,

    generic=True,

)

coreconfigitem(

    b'color',

    b'mode',

    default=b'auto',

)

coreconfigitem(

    b'color',

    b'pagermode',

    default=dynamicdefault,

)

coreconfigitem(

    b'command-templates',

    b'graphnode',

    default=None,

    alias=[(b'ui', b'graphnodetemplate')],

)

coreconfigitem(

    b'command-templates',

    b'log',

    default=None,

    alias=[(b'ui', b'logtemplate')],

)

coreconfigitem(

    b'command-templates',

    b'mergemarker',

    default=(

        b'{node|short} '

        b'{ifeq(tags, "tip", "", '

        b'ifeq(tags, "", "", "{tags} "))}'

        b'{if(bookmarks, "{bookmarks} ")}'

        b'{ifeq(branch, "default", "", "{branch} ")}'

        b'- {author|user}: {desc|firstline}'

    ),

    alias=[(b'ui', b'mergemarkertemplate')],

)

coreconfigitem(

    b'command-templates',

    b'pre-merge-tool-output',

    default=None,

    alias=[(b'ui', b'pre-merge-tool-output-template')],

)

coreconfigitem(

    b'command-templates',

    b'oneline-summary',

    default=None,

)

coreconfigitem(

    b'command-templates',

    b'oneline-summary.*',

    default=dynamicdefault,

    generic=True,

)

_registerdiffopts(section=b'commands', configprefix=b'commit.interactive.')

coreconfigitem(

    b'commands',

    b'commit.post-status',

    default=False,

)

coreconfigitem(

    b'commands',

    b'grep.all-files',

    default=False,

    experimental=True,

)

coreconfigitem(

    b'commands',

    b'merge.require-rev',

    default=False,

)

coreconfigitem(

    b'commands',

    b'push.require-revs',

    default=False,

)

coreconfigitem(

    b'commands',

    b'resolve.confirm',

    default=False,

)

coreconfigitem(

    b'commands',

    b'resolve.explicit-re-merge',

    default=False,

)

coreconfigitem(

    b'commands',

    b'resolve.mark-check',

    default=b'none',

)

_registerdiffopts(section=b'commands', configprefix=b'revert.interactive.')

coreconfigitem(

    b'commands',

    b'show.aliasprefix',

    default=list,

)

coreconfigitem(

    b'commands',

    b'status.relative',

    default=False,

)

coreconfigitem(

    b'commands',

    b'status.skipstates',

    default=[],

    experimental=True,

)

coreconfigitem(

    b'commands',

    b'status.terse',

    default=b'',

)

coreconfigitem(

    b'commands',

    b'status.verbose',

    default=False,

)

coreconfigitem(

    b'commands',

    b'update.check',

    default=None,

)

coreconfigitem(

    b'commands',

    b'update.requiredest',

    default=False,

)

coreconfigitem(

    b'committemplate',

    b'.*',

    default=None,

    generic=True,

)

coreconfigitem(

    b'convert',

    b'bzr.saverev',

    default=True,