← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/cache_utf8.py

  • Committer: Martin Pool
  • Date: 2005-04-28 07:24:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050428072453-7b99afa993a1e549
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cache_utf8.py
1
 
# Copyright (C) 2006 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
 
# TODO: Some kind of command-line display of revision properties:
18
 
# perhaps show them in log -v and allow them as options to the commit command.
19
 
 
20
 
"""Some functions to enable caching the conversion between unicode to utf8"""
21
 
 
22
 
from __future__ import absolute_import
23
 
 
24
 
import codecs
25
 
 
26
 
_utf8_encode = codecs.utf_8_encode
27
 
_utf8_decode = codecs.utf_8_decode
28
 
def _utf8_decode_with_None(bytestring, _utf8_decode=_utf8_decode):
29
 
    """wrap _utf8_decode to support None->None for optional strings.
30
 
 
31
 
    Also, only return the Unicode portion, since we don't care about the second
32
 
    return value.
33
 
    """
34
 
    if bytestring is None:
35
 
        return None
36
 
    else:
37
 
        return _utf8_decode(bytestring)[0]
38
 
 
39
 
# Map revisions from and to utf8 encoding
40
 
# Whenever we do an encode/decode operation, we save the result, so that
41
 
# we don't have to do it again.
42
 
_unicode_to_utf8_map = {}
43
 
_utf8_to_unicode_map = {}
44
 
 
45
 
 
46
 
def encode(unicode_str,
47
 
           _uni_to_utf8=_unicode_to_utf8_map,
48
 
           _utf8_to_uni=_utf8_to_unicode_map,
49
 
           _utf8_encode=_utf8_encode):
50
 
    """Take this unicode revision id, and get a unicode version"""
51
 
    # If the key is in the cache try/KeyError is 50% faster than
52
 
    # val = dict.get(key), if val is None:
53
 
    # On jam's machine the difference is
54
 
    # try/KeyError:  900ms
55
 
    #      if None: 1250ms
56
 
    # Since these are primarily used when iterating over a knit entry
57
 
    # *most* of the time the key will already be in the cache, so use the
58
 
    # fast path
59
 
    try:
60
 
        return _uni_to_utf8[unicode_str]
61
 
    except KeyError:
62
 
        _uni_to_utf8[unicode_str] = utf8_str = _utf8_encode(unicode_str)[0]
63
 
        _utf8_to_uni[utf8_str] = unicode_str
64
 
        return utf8_str
65
 
 
66
 
 
67
 
def decode(utf8_str,
68
 
           _uni_to_utf8=_unicode_to_utf8_map,
69
 
           _utf8_to_uni=_utf8_to_unicode_map,
70
 
           _utf8_decode=_utf8_decode):
71
 
    """Take a utf8 revision id, and decode it, but cache the result"""
72
 
    try:
73
 
        return _utf8_to_uni[utf8_str]
74
 
    except KeyError:
75
 
        unicode_str = _utf8_decode(utf8_str)[0]
76
 
        _utf8_to_uni[utf8_str] = unicode_str
77
 
        _uni_to_utf8[unicode_str] = utf8_str
78
 
        return unicode_str
79
 
 
80
 
 
81
 
def get_cached_unicode(unicode_str):
82
 
    """Return a cached version of the unicode string.
83
 
 
84
 
    This has a similar idea to that of intern() in that it tries
85
 
    to return a singleton string. Only it works for unicode strings.
86
 
    """
87
 
    # This might return the same object, or it might return the cached one
88
 
    # the decode() should just be a hash lookup, because the encode() side
89
 
    # should add the entry to the maps
90
 
    return decode(encode(unicode_str))
91
 
 
92
 
 
93
 
def get_cached_utf8(utf8_str):
94
 
    """Return a cached version of the utf-8 string.
95
 
 
96
 
    Get a cached version of this string (similar to intern()).
97
 
    At present, this will be decoded to ensure it is a utf-8 string. In the
98
 
    future this might change to simply caching the string.
99
 
    """
100
 
    return encode(decode(utf8_str))
101
 
 
102
 
 
103
 
def get_cached_ascii(ascii_str,
104
 
                     _uni_to_utf8=_unicode_to_utf8_map,
105
 
                     _utf8_to_uni=_utf8_to_unicode_map):
106
 
    """This is a string which is identical in utf-8 and unicode."""
107
 
    # We don't need to do any encoding, but we want _utf8_to_uni to return a
108
 
    # real Unicode string. Unicode and plain strings of this type will have the
109
 
    # same hash, so we can just use it as the key in _uni_to_utf8, but we need
110
 
    # the return value to be different in _utf8_to_uni
111
 
    ascii_str = _uni_to_utf8.setdefault(ascii_str, ascii_str)
112
 
    _utf8_to_uni.setdefault(ascii_str, unicode(ascii_str))
113
 
    return ascii_str
114
 
 
115
 
 
116
 
def clear_encoding_cache():
117
 
    """Clear the encoding and decoding caches"""
118
 
    _unicode_to_utf8_map.clear()
119
 
    _utf8_to_unicode_map.clear()