← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rules.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-04 22:17:22 UTC
  • mfrom: (5815.3.15 use-tree-annotate)
  • Revision ID: pqm@pqm.ubuntu.com-20110504221722-fz5hr1xagchptyje
(jelmer) Avoid directly accessing VersionedFiles.annotate();
 rather, access it through RevisionTree.annotate_iter(). (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rules.py
 
1
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Rule-based definition of preferences for selected files in selected branches.
 
18
 
 
19
See ``bzr help rules`` for details.
 
20
"""
 
21
 
 
22
from bzrlib import (
 
23
    config,
 
24
    cmdline,
 
25
    errors,
 
26
    globbing,
 
27
    osutils,
 
28
    )
 
29
from bzrlib.util.configobj import configobj
 
30
 
 
31
 
 
32
# Name of the file holding rules in a tree
 
33
RULES_TREE_FILENAME = ".bzrrules"
 
34
 
 
35
# Namespace prefix for per file preferences
 
36
FILE_PREFS_PREFIX = 'name '
 
37
FILE_PREFS_PREFIX_LEN = len(FILE_PREFS_PREFIX)
 
38
 
 
39
# The object providing default rules
 
40
_per_user_searcher = None
 
41
 
 
42
 
 
43
class _RulesSearcher(object):
 
44
    """An object that provides rule-based preferences."""
 
45
 
 
46
    def get_items(self, path):
 
47
        """Return the preferences for a path as name,value tuples.
 
48
 
 
49
        :param path: tree relative path
 
50
        :return: () if no rule matched, otherwise a sequence of name,value
 
51
          tuples.
 
52
        """
 
53
        raise NotImplementedError(self.get_items)
 
54
 
 
55
    def get_selected_items(self, path, names):
 
56
        """Return selected preferences for a path as name,value tuples.
 
57
 
 
58
        :param path: tree relative path
 
59
        :param names: the list of preferences to lookup
 
60
        :return: () if no rule matched, otherwise a sequence of name,value
 
61
          tuples. The sequence is the same length as names,
 
62
          tuple order matches the order in names, and
 
63
          undefined preferences are given the value None.
 
64
        """
 
65
        raise NotImplementedError(self.get_selected_items)
 
66
 
 
67
 
 
68
class _IniBasedRulesSearcher(_RulesSearcher):
 
69
 
 
70
    def __init__(self, inifile):
 
71
        """Construct a _RulesSearcher based on an ini file.
 
72
 
 
73
        The content will be decoded as utf-8.
 
74
 
 
75
        :param inifile: the name of the file or a sequence of lines.
 
76
        """
 
77
        self._cfg = configobj.ConfigObj(inifile, encoding='utf-8')
 
78
        sections = self._cfg.keys()
 
79
        patterns = []
 
80
        self.pattern_to_section = {}
 
81
        for s in sections:
 
82
            if s.startswith(FILE_PREFS_PREFIX):
 
83
                file_patterns = cmdline.split(s[FILE_PREFS_PREFIX_LEN:])
 
84
                patterns.extend(file_patterns)
 
85
                for fp in file_patterns:
 
86
                    self.pattern_to_section[fp] = s
 
87
        if len(patterns) < len(sections):
 
88
            unknowns = [s for s in sections
 
89
                if not s.startswith(FILE_PREFS_PREFIX)]
 
90
            raise errors.UnknownRules(unknowns)
 
91
        elif patterns:
 
92
            self._globster = globbing._OrderedGlobster(patterns)
 
93
        else:
 
94
            self._globster = None
 
95
 
 
96
    def get_items(self, path):
 
97
        """See _RulesSearcher.get_items."""
 
98
        if self._globster is None:
 
99
            return ()
 
100
        pat = self._globster.match(path)
 
101
        if pat is None:
 
102
            return ()
 
103
        else:
 
104
            all = self._cfg[self.pattern_to_section[pat]]
 
105
            return tuple(all.items())
 
106
 
 
107
    def get_selected_items(self, path, names):
 
108
        """See _RulesSearcher.get_selected_items."""
 
109
        if self._globster is None:
 
110
            return ()
 
111
        pat = self._globster.match(path)
 
112
        if pat is None:
 
113
            return ()
 
114
        else:
 
115
            all = self._cfg[self.pattern_to_section[pat]]
 
116
            return tuple((k, all.get(k)) for k in names)
 
117
 
 
118
 
 
119
class _StackedRulesSearcher(_RulesSearcher):
 
120
 
 
121
    def __init__(self, searchers):
 
122
        """Construct a _RulesSearcher based on a stack of other ones.
 
123
 
 
124
        :param searchers: a sequence of searchers.
 
125
        """
 
126
        self.searchers = searchers
 
127
 
 
128
    def get_items(self, path):
 
129
        """See _RulesSearcher.get_items."""
 
130
        for searcher in self.searchers:
 
131
            result = searcher.get_items(path)
 
132
            if result:
 
133
                return result
 
134
        return ()
 
135
 
 
136
    def get_selected_items(self, path, names):
 
137
        """See _RulesSearcher.get_selected_items."""
 
138
        for searcher in self.searchers:
 
139
            result = searcher.get_selected_items(path, names)
 
140
            if result:
 
141
                return result
 
142
        return ()
 
143
 
 
144
 
 
145
def rules_filename():
 
146
    """Return the default rules filename."""
 
147
    return osutils.pathjoin(config.config_dir(), 'rules')
 
148
 
 
149
 
 
150
def reset_rules():
 
151
    global _per_user_searcher
 
152
    _per_user_searcher = _IniBasedRulesSearcher(rules_filename())
 
153
 
 
154
reset_rules()