hgkw/keyword.py
author Christian Ebert <blacktrash@gmx.net>
Fri, 26 Jan 2007 12:10:53 +0000
branchkwmap-templates
changeset 122 d5c80df59655
parent 120 4a8a861da58c
child 123 6cf933de685a
permissions -rw-r--r--
No reposetup when no filenames are specified for expansion Second stab at stopping reposetup. This time kwtemplater is still initialized in kwfilelog and pretxnkw, and not in reposetup. Watchout: Giving ui an extra-attribute in reposetup might still be problematic.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
     1
# keyword.py - keyword expansion for Mercurial
120
4a8a861da58c Add licence (again)
Christian Ebert <blacktrash@gmx.net>
parents: 119
diff changeset
     2
#
4a8a861da58c Add licence (again)
Christian Ebert <blacktrash@gmx.net>
parents: 119
diff changeset
     3
# Copyright 2007 Christian Ebert <blacktrash@gmx.net>
4a8a861da58c Add licence (again)
Christian Ebert <blacktrash@gmx.net>
parents: 119
diff changeset
     4
#
4a8a861da58c Add licence (again)
Christian Ebert <blacktrash@gmx.net>
parents: 119
diff changeset
     5
# This software may be used and distributed according to the terms
4a8a861da58c Add licence (again)
Christian Ebert <blacktrash@gmx.net>
parents: 119
diff changeset
     6
# of the GNU General Public License, incorporated herein by reference.
4a8a861da58c Add licence (again)
Christian Ebert <blacktrash@gmx.net>
parents: 119
diff changeset
     7
#
82
9bf0f7db5928 Add keyword; comment backwards compatible import
Christian Ebert <blacktrash@gmx.net>
parents: 81
diff changeset
     8
# $Id$
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
     9
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    10
# Keyword expansion hack against the grain of a DSCM
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    11
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    12
# There are many good reasons why this is not needed in a distributed
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    13
# SCM, still it may be useful in very small projects based on single
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    14
# files (like LaTeX packages), that are mostly addressed to an audience
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    15
# not running a version control system.
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    16
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    17
# For in-depth discussion refer to
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    18
# <http://www.selenic.com/mercurial/wiki/index.cgi/KeywordPlan>.
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    19
#
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    20
# Keyword expansion is based on Mercurial's changeset template mappings.
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    21
# The extension provides an additional UTC-date filter ({date|utcdate}).
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    22
#
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    23
# The user has the choice either to create his own keywords and their
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    24
# expansions or to use the CVS-like default ones.
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    25
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    26
# Default $keywords$ and their $keyword: substition $ are:
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    27
#     Revision: changeset id
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    28
#     Author:   username
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    29
#     Date:     %Y/%m/%d %H:%M:%S [UTC]
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    30
#     RCSFile:  basename,v
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    31
#     Source:   /path/to/basename,v
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    32
#     Id:       basename,v csetid %Y/%m/%d %H:%M:%S username
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    33
#     Header:   /path/to/basename,v csetid %Y/%m/%d %H:%M:%S username
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    34
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    35
# Expansions spanning more than one line are truncated to their first line.
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    36
# Incremental expansion (like CVS' $Log$) is not supported.
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    37
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    38
# Simple setup in hgrc:
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    39
# 
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    40
#     # enable extension
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    41
#     keyword = /full/path/to/keyword.py
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    42
#     # or, if script in hgext folder:
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    43
#     # hgext.keyword =
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    44
#     
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    45
#     # filename patterns for expansion are configured in this section
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    46
#     # files matching patterns with value 'ignore' are ignored
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    47
#     [keyword]
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    48
#     **.py =
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    49
#     x* = ignore
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    50
#     ...
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    51
#     # in case you prefer your own keyword maps over the cvs-like defaults:
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    52
#     [keywordmaps]
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    53
#     HGdate = {date|rfc822date}
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    54
#     lastlog = {desc} ## same as {desc|firstline} in this context
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    55
#     checked in by = {author}
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    56
#     ...
48
59fedb6b41da add header and start documentation
Christian Ebert <blacktrash@gmx.net>
parents: 47
diff changeset
    57
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    58
'''keyword expansion in local repositories
48
59fedb6b41da add header and start documentation
Christian Ebert <blacktrash@gmx.net>
parents: 47
diff changeset
    59
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    60
This extension expands RCS/CVS-like or self-customized keywords in
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    61
the text files selected by your configuration.
102
393d6f8ea83c More doc, link to KeywordPlan
Christian Ebert <blacktrash@gmx.net>
parents: 101
diff changeset
    62
114
09847a7eb5d7 Describe substitution mechanism in doc
Christian Ebert <blacktrash@gmx.net>
parents: 113
diff changeset
    63
Keywords are only expanded in local repositories and not logged by
09847a7eb5d7 Describe substitution mechanism in doc
Christian Ebert <blacktrash@gmx.net>
parents: 113
diff changeset
    64
Mercurial internally. The mechanism can be regarded as a convenience
09847a7eb5d7 Describe substitution mechanism in doc
Christian Ebert <blacktrash@gmx.net>
parents: 113
diff changeset
    65
for the current user and may be turned off anytime.
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    66
 
114
09847a7eb5d7 Describe substitution mechanism in doc
Christian Ebert <blacktrash@gmx.net>
parents: 113
diff changeset
    67
Substitution takes place on every commit and update of the working
09847a7eb5d7 Describe substitution mechanism in doc
Christian Ebert <blacktrash@gmx.net>
parents: 113
diff changeset
    68
repository.
108
25dac950a1f0 Document reposetup; recommend loading on per-repo basis
Christian Ebert <blacktrash@gmx.net>
parents: 107
diff changeset
    69
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    70
Configuration is done in the [keyword] and [keywordmaps] sections of
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    71
hgrc files.
48
59fedb6b41da add header and start documentation
Christian Ebert <blacktrash@gmx.net>
parents: 47
diff changeset
    72
'''
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
    73
 
105
2a8b0a71c2ec Use full power of util.matcher for kwfmatches()
Christian Ebert <blacktrash@gmx.net>
parents: 104
diff changeset
    74
from mercurial.i18n import gettext as _
2a8b0a71c2ec Use full power of util.matcher for kwfmatches()
Christian Ebert <blacktrash@gmx.net>
parents: 104
diff changeset
    75
# above line for backwards compatibility; can be changed to
2a8b0a71c2ec Use full power of util.matcher for kwfmatches()
Christian Ebert <blacktrash@gmx.net>
parents: 104
diff changeset
    76
#   from mercurial.i18n import _
2a8b0a71c2ec Use full power of util.matcher for kwfmatches()
Christian Ebert <blacktrash@gmx.net>
parents: 104
diff changeset
    77
# some day
110
b0b85b383f36 Move all that can be done only once per repo into reposetup
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
    78
from mercurial import context, filelog, revlog
b0b85b383f36 Move all that can be done only once per repo into reposetup
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
    79
from mercurial import commands, cmdutil, templater, util
115
520818841684 FIX: no appending of attributes to repo, back to b2cc6a8d4a18
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
    80
from mercurial.node import bin
90
2e930f842242 Very CVS-like format
Christian Ebert <blacktrash@gmx.net>
parents: 89
diff changeset
    81
import os.path, re, sys, time
47
0617e7d497f6 Branch standalone extension, including pretxncommit hook function
Christian Ebert <blacktrash@gmx.net>
parents: 44
diff changeset
    82
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    83
deftemplates = {
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    84
        'Revision': '{node|short}',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    85
        'Author': '{author|user}',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    86
        'Date': '{date|utcdate}',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    87
        'RCSFile': '{file|basename},v',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    88
        'Source': '{root}/{file},v',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    89
        'Id': '{file|basename},v {node|short} {date|utcdate} {author|user}',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    90
        'Header': '{root}/{file},v {node|short} {date|utcdate} {author|user}',
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    91
        }
59
94b26168791d Only 1 all-purpose regex, compiled at load
Christian Ebert <blacktrash@gmx.net>
parents: 58
diff changeset
    92
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    93
def utcdate(date):
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    94
    '''Returns hgdate in cvs-like UTC format.'''
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    95
    return time.strftime('%Y/%m/%d %H:%M:%S', time.gmtime(date[0]))
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
    96
111
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
    97
def getmodulename():
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
    98
    '''Makes sure pretxncommit-hook can import keyword module
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
    99
    regardless of where its located.'''
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   100
    for k, v in sys.modules.iteritems():
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   101
        if v is None:
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   102
            continue
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   103
        if not hasattr(v, '__file__'):
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   104
            continue
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   105
        if v.__file__.startswith(__file__):
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   106
            return k
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   107
    else:
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   108
        sys.path.insert(0, os.path.abspath(os.path.dirname(__file__)))
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   109
        return os.path.splitext(os.path.basename(__file__))[0]
65
188849659487 Unify obtaining filename matchers; only debug messages
Christian Ebert <blacktrash@gmx.net>
parents: 64
diff changeset
   110
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   111
class kwtemplater(object):
92
3c7c187e4001 Init context.filectx only once per file with class kwfilectx
Christian Ebert <blacktrash@gmx.net>
parents: 90
diff changeset
   112
    '''
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   113
    Sets up keyword templates, corresponding keyword regex, and
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   114
    provides keyword expansion function.
92
3c7c187e4001 Init context.filectx only once per file with class kwfilectx
Christian Ebert <blacktrash@gmx.net>
parents: 90
diff changeset
   115
    '''
101
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   116
    def __init__(self, ui, repo):
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   117
        self.ui = ui
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   118
        self.repo = repo
106
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   119
        self.templates = dict(ui.configitems('keywordmaps')) or deftemplates
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   120
        self.re_kw = re.compile(r'\$(%s)[^$]*?\$' %
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   121
                '|'.join(re.escape(k) for k in self.templates.keys()))
109
b2cc6a8d4a18 Extend templater.common_filters in kwtemplater
Christian Ebert <blacktrash@gmx.net>
parents: 108
diff changeset
   122
        templater.common_filters['utcdate'] = utcdate
106
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   123
        self.t = cmdutil.changeset_templater(ui, repo, False, '', False)
107
fe4a0495eca8 Implement configurable exclusion of files from expansion
Christian Ebert <blacktrash@gmx.net>
parents: 106
diff changeset
   124
            
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   125
101
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   126
    def expand(self, mobj, path, node):
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
   127
        '''Expands keyword using corresponding template.'''
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   128
        kw = mobj.group(1)
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   129
        template = templater.parsestring(self.templates[kw], quoted=False)
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   130
        self.t.use_template(template)
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   131
        self.ui.pushbuffer()
101
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   132
        self.t.show(changenode=node, root=self.repo.root, file=path)
110
b0b85b383f36 Move all that can be done only once per repo into reposetup
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
   133
        kwsub = templater.firstline(self.ui.popbuffer())
b0b85b383f36 Move all that can be done only once per repo into reposetup
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
   134
        return '$%s: %s $' % (kw, kwsub)
92
3c7c187e4001 Init context.filectx only once per file with class kwfilectx
Christian Ebert <blacktrash@gmx.net>
parents: 90
diff changeset
   135
42
ba000e29ecf3 Implement near CVS compability with more than one keyword
Christian Ebert <blacktrash@gmx.net>
parents: 41
diff changeset
   136
33
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   137
def reposetup(ui, repo):
108
25dac950a1f0 Document reposetup; recommend loading on per-repo basis
Christian Ebert <blacktrash@gmx.net>
parents: 107
diff changeset
   138
    '''Sets up repo, and filelog especially, as kwrepo and kwfilelog
118
d9cea05cb74c Prepare test: split doc into help and comment
Christian Ebert <blacktrash@gmx.net>
parents: 117
diff changeset
   139
    for keyword substitution. This is done for local repos only.'''
108
25dac950a1f0 Document reposetup; recommend loading on per-repo basis
Christian Ebert <blacktrash@gmx.net>
parents: 107
diff changeset
   140
110
b0b85b383f36 Move all that can be done only once per repo into reposetup
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
   141
    if not repo.local():
b0b85b383f36 Move all that can be done only once per repo into reposetup
Christian Ebert <blacktrash@gmx.net>
parents: 109
diff changeset
   142
        return
108
25dac950a1f0 Document reposetup; recommend loading on per-repo basis
Christian Ebert <blacktrash@gmx.net>
parents: 107
diff changeset
   143
122
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   144
    inc, exc = [], ['.hg*']
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   145
    for pat, opt in ui.configitems('keyword'):
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   146
        if opt != 'ignore':
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   147
            inc.append(pat)
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   148
        else:
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   149
            exc.append(pat)
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   150
    if not inc:
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   151
        return
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   152
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   153
    ui.kwfmatcher = util.matcher(repo.root, inc=inc, exc=exc)[1]
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   154
33
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   155
    class kwrepo(repo.__class__):
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   156
        def file(self, f):
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   157
            if f[0] == '/':
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   158
                f = f[1:]
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   159
            return filelog.filelog(self.sopener, f, self, self.revlogversion)
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   160
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   161
    class kwfilelog(filelog.filelog):
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   162
        '''
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   163
        Superclass over filelog to customize it's read, add, cmp methods.
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   164
        Keywords are "stored" unexpanded, and expanded on reading.
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   165
        '''
33
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   166
        def __init__(self, opener, path, repo,
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   167
                     defversion=revlog.REVLOG_DEFAULT_VERSION):
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   168
            super(kwfilelog, self).__init__(opener, path, defversion)
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   169
            self._repo = repo
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   170
            self._path = path
106
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   171
            # only init kwtemplater if needed
122
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   172
            if not isinstance(repo, int) and ui.kwfmatcher(path):
106
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   173
                self.kwt = kwtemplater(ui, repo)
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   174
            else:
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   175
                self.kwt = None
36
b3ace8cc5a33 Change config opt "expand" to accept filename patterns
Christian Ebert <blacktrash@gmx.net>
parents: 34
diff changeset
   176
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   177
        def iskwcandidate(self, data):
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   178
            '''Decides whether to act on keywords.'''
106
61afa140949e Only initialize kwtemplater in kwfilelog if needed
Christian Ebert <blacktrash@gmx.net>
parents: 105
diff changeset
   179
            return self.kwt is not None and not util.binary(data)
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   180
33
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   181
        def read(self, node):
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   182
            '''Substitutes keywords when reading filelog.'''
42
ba000e29ecf3 Implement near CVS compability with more than one keyword
Christian Ebert <blacktrash@gmx.net>
parents: 41
diff changeset
   183
            data = super(kwfilelog, self).read(node)
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   184
            if self.iskwcandidate(data):
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   185
                c = context.filectx(self._repo, self._path,
100
4f1129ddbdb8 Just re-bin the node kwarg of the hook, instead of using changelog
Christian Ebert <blacktrash@gmx.net>
parents: 99
diff changeset
   186
                                    fileid=node, filelog=self)
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   187
                return self.kwt.re_kw.sub(lambda m:
101
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   188
                        self.kwt.expand(m, self._path, c.node()), data)
51
1ecb6ec5d16b Reintroduce simpler kwfilelog.add(); simplify kwfilelog.read()
Christian Ebert <blacktrash@gmx.net>
parents: 50
diff changeset
   189
            return data
42
ba000e29ecf3 Implement near CVS compability with more than one keyword
Christian Ebert <blacktrash@gmx.net>
parents: 41
diff changeset
   190
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   191
        def add(self, text, meta, tr, link, p1=None, p2=None):
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   192
            '''Removes keyword substitutions when adding to filelog.'''
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   193
            if self.iskwcandidate(text):
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   194
                text = self.kwt.re_kw.sub(r'$\1$', text)
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   195
            return super(kwfilelog, self).add(text,
102
393d6f8ea83c More doc, link to KeywordPlan
Christian Ebert <blacktrash@gmx.net>
parents: 101
diff changeset
   196
                            meta, tr, link, p1=p1, p2=p2)
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   197
49
5acfe7dc3086 Override filelog's size(), cmp() as well; remove add()
Christian Ebert <blacktrash@gmx.net>
parents: 48
diff changeset
   198
        def cmp(self, node, text):
78
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   199
            '''Removes keyword substitutions for comparison.'''
474b415433a1 Unexpanded storage hopefully covered now by adding kwfilelog.add (again!)
Christian Ebert <blacktrash@gmx.net>
parents: 77
diff changeset
   200
            if self.iskwcandidate(text):
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   201
                text = self.kwt.re_kw.sub(r'$\1$', text)
71
f7a2a246740c No keyword substitution in cmp(); no overriding of size() ATM
Christian Ebert <blacktrash@gmx.net>
parents: 69
diff changeset
   202
            return super(kwfilelog, self).cmp(node, text)
33
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   203
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   204
    filelog.filelog = kwfilelog
ebb39c6a1476 Add original keyword extension by Thomas Arendsen Hain
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
   205
    repo.__class__ = kwrepo
111
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   206
    # configure pretxncommit hook
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   207
    ui.setconfig('hooks', 'pretxncommit.keyword',
94315baadcaf Get modulename via function; set kwrepo attribs via direct reference
Christian Ebert <blacktrash@gmx.net>
parents: 110
diff changeset
   208
            'python:%s.pretxnkw' % getmodulename())
81
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   209
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   210
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   211
def pretxnkw(ui, repo, hooktype, **args):
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   212
    '''pretxncommit hook that collects candidates for keyword expansion
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   213
    on commit and expands keywords in working dir.'''
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   214
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   215
    cmd, sysargs, globalopts, cmdopts = commands.parse(ui, sys.argv[1:])[1:]
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   216
    if repr(cmd).split()[1] in ('tag', 'import_'):
99
f881ecdcdec9 Same as for hardcoded branch: omit hooktype test, return w/o explicit value
Christian Ebert <blacktrash@gmx.net>
parents: 97
diff changeset
   217
        return
81
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   218
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   219
    files, match, anypats = cmdutil.matchpats(repo, sysargs, cmdopts)
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   220
    modified, added = repo.status(files=files, match=match)[:2]
122
d5c80df59655 No reposetup when no filenames are specified for expansion
Christian Ebert <blacktrash@gmx.net>
parents: 120
diff changeset
   221
    candidates = [f for f in modified + added if ui.kwfmatcher(f)]
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   222
    if not candidates:
99
f881ecdcdec9 Same as for hardcoded branch: omit hooktype test, return w/o explicit value
Christian Ebert <blacktrash@gmx.net>
parents: 97
diff changeset
   223
        return
81
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   224
101
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   225
    kwt = kwtemplater(ui, repo)
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   226
    node = bin(args['node'])
95
9e4cbe64fb4f Implement custom keyword map templates in hgrc
Christian Ebert <blacktrash@gmx.net>
parents: 93
diff changeset
   227
    for f in candidates:
81
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   228
        data = repo.wfile(f).read()
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   229
        if not util.binary(data):
101
98a65d978098 No need to read changelog in show(); node mandatory arg for expand()
Christian Ebert <blacktrash@gmx.net>
parents: 100
diff changeset
   230
            data, kwct = kwt.re_kw.subn(lambda m: kwt.expand(m, f, node), data)
81
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   231
            if kwct:
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   232
                ui.debug(_('overwriting %s expanding keywords\n' % f))
fd5d3a974ea7 Implement self initializing pretxncommit hook
Christian Ebert <blacktrash@gmx.net>
parents: 80
diff changeset
   233
                repo.wfile(f, 'w').write(data)