~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/win32utils.py

  • Committer: John Arbash Meinel
  • Date: 2009-03-06 20:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4088.
  • Revision ID: john@arbash-meinel.com-20090306204240-mzjavv31z3gu1x7i
Fix a small bug in setup.py when an extension fails to build

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Win32-specific helper functions
18
18
 
19
19
Only one dependency: ctypes should be installed.
20
20
"""
21
21
 
22
 
import glob
23
22
import os
24
 
import re
25
23
import struct
26
24
import sys
27
25
 
68
66
        suffix = 'W'
69
67
try:
70
68
    import win32file
71
 
    import pywintypes
72
69
    has_win32file = True
73
70
except ImportError:
74
71
    has_win32file = False
99
96
UNLEN = 256
100
97
MAX_COMPUTERNAME_LENGTH = 31
101
98
 
102
 
# Registry data type ids
103
 
REG_SZ = 1
104
 
REG_EXPAND_SZ = 2
105
 
 
106
99
 
107
100
def debug_memory_win32api(message='', short=True):
108
101
    """Use trace.note() to dump the running memory info."""
135
128
                'WorkingSetSize': mem_struct.WorkingSetSize,
136
129
                'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
137
130
                'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
138
 
                'QuotaPeakNonPagedPoolUsage':
139
 
                    mem_struct.QuotaPeakNonPagedPoolUsage,
 
131
                'QuotaPeakNonPagedPoolUsage': mem_struct.QuotaPeakNonPagedPoolUsage,
140
132
                'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
141
133
                'PagefileUsage': mem_struct.PagefileUsage,
142
134
                'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
152
144
        trace.note('Cannot debug memory on win32 without ctypes'
153
145
                   ' or win32process')
154
146
        return
 
147
    trace.note('WorkingSize       %8d kB', info['WorkingSetSize'] / 1024)
 
148
    trace.note('PeakWorking       %8d kB', info['PeakWorkingSetSize'] / 1024)
155
149
    if short:
156
 
        # using base-2 units (see HACKING.txt).
157
 
        trace.note('WorkingSize %7dKiB'
158
 
                   '\tPeakWorking %7dKiB\t%s',
159
 
                   info['WorkingSetSize'] / 1024,
160
 
                   info['PeakWorkingSetSize'] / 1024,
161
 
                   message)
162
150
        return
163
 
    if message:
164
 
        trace.note('%s', message)
165
 
    trace.note('WorkingSize       %8d KiB', info['WorkingSetSize'] / 1024)
166
 
    trace.note('PeakWorking       %8d KiB', info['PeakWorkingSetSize'] / 1024)
167
 
    trace.note('PagefileUsage     %8d KiB', info.get('PagefileUsage', 0) / 1024)
168
 
    trace.note('PeakPagefileUsage %8d KiB',
169
 
               info.get('PeakPagefileUsage', 0) / 1024)
170
 
    trace.note('PrivateUsage      %8d KiB', info.get('PrivateUsage', 0) / 1024)
 
151
    trace.note('PagefileUsage     %8d kB', info.get('PagefileUsage', 0) / 1024)
 
152
    trace.note('PeakPagefileUsage %8d kB', info.get('PeakPagefileUsage', 0) / 1024)
 
153
    trace.note('PrivateUsage      %8d kB', info.get('PrivateUsage', 0) / 1024)
171
154
    trace.note('PageFaultCount    %8d', info.get('PageFaultCount', 0))
172
155
 
173
156
 
183
166
        return (defaultx, defaulty)
184
167
 
185
168
    # To avoid problem with redirecting output via pipe
186
 
    # we need to use stderr instead of stdout
 
169
    # need to use stderr instead of stdout
187
170
    h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
188
171
    csbi = ctypes.create_string_buffer(22)
189
172
    res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
190
173
 
191
174
    if res:
192
175
        (bufx, bufy, curx, cury, wattr,
193
 
        left, top, right, bottom, maxx, maxy) = struct.unpack(
194
 
            "hhhhHhhhhhh", csbi.raw)
 
176
        left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
195
177
        sizex = right - left + 1
196
178
        sizey = bottom - top + 1
197
179
        return (sizex, sizey)
278
260
 
279
261
    Returned value can be unicode or plain string.
280
262
    To convert plain string to unicode use
281
 
    s.decode(osutils.get_user_encoding())
 
263
    s.decode(bzrlib.user_encoding)
282
264
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
283
265
    """
284
266
    local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
297
279
    If location cannot be obtained return system drive root,
298
280
    i.e. C:\
299
281
 
300
 
    Returned value can be unicode or plain string.
 
282
    Returned value can be unicode or plain sring.
301
283
    To convert plain string to unicode use
302
284
    s.decode(osutils.get_user_encoding())
303
285
    """
320
302
    """Return user name as login name.
321
303
    If name cannot be obtained return None.
322
304
 
323
 
    Returned value can be unicode or plain string.
 
305
    Returned value can be unicode or plain sring.
324
306
    To convert plain string to unicode use
325
307
    s.decode(osutils.get_user_encoding())
326
308
    """
394
376
 
395
377
 
396
378
def _ensure_unicode(s):
 
379
    from bzrlib import osutils
397
380
    if s and type(s) != unicode:
398
381
        from bzrlib import osutils
399
382
        s = s.decode(osutils.get_user_encoding())
414
397
 
415
398
 
416
399
def _ensure_with_dir(path):
417
 
    if (not os.path.split(path)[0] or path.startswith(u'*')
418
 
        or path.startswith(u'?')):
 
400
    if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
419
401
        return u'./' + path, True
420
402
    else:
421
403
        return path, False
428
410
 
429
411
 
430
412
 
431
 
def glob_one(possible_glob):
432
 
    """Same as glob.glob().
433
 
 
434
 
    work around bugs in glob.glob()
435
 
    - Python bug #1001604 ("glob doesn't return unicode with ...")
436
 
    - failing expansion for */* with non-iso-8859-* chars
437
 
    """
438
 
    corrected_glob, corrected = _ensure_with_dir(possible_glob)
439
 
    glob_files = glob.glob(corrected_glob)
440
 
 
441
 
    if not glob_files:
442
 
        # special case to let the normal code path handle
443
 
        # files that do not exist, etc.
444
 
        glob_files = [possible_glob]
445
 
    elif corrected:
446
 
        glob_files = [_undo_ensure_with_dir(elem, corrected)
447
 
                      for elem in glob_files]
448
 
    return [elem.replace(u'\\', u'/') for elem in glob_files]
449
 
 
450
 
 
451
413
def glob_expand(file_list):
452
414
    """Replacement for glob expansion by the shell.
453
415
 
461
423
    """
462
424
    if not file_list:
463
425
        return []
 
426
    import glob
464
427
    expanded_file_list = []
465
428
    for possible_glob in file_list:
466
 
        expanded_file_list.extend(glob_one(possible_glob))
467
 
    return expanded_file_list
 
429
 
 
430
        # work around bugs in glob.glob()
 
431
        # - Python bug #1001604 ("glob doesn't return unicode with ...")
 
432
        # - failing expansion for */* with non-iso-8859-* chars
 
433
        possible_glob, corrected = _ensure_with_dir(possible_glob)
 
434
        glob_files = glob.glob(possible_glob)
 
435
 
 
436
        if glob_files == []:
 
437
            # special case to let the normal code path handle
 
438
            # files that do not exists
 
439
            expanded_file_list.append(
 
440
                _undo_ensure_with_dir(possible_glob, corrected))
 
441
        else:
 
442
            glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
 
443
            expanded_file_list += glob_files
 
444
 
 
445
    return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
468
446
 
469
447
 
470
448
def get_app_path(appname):
471
449
    """Look up in Windows registry for full path to application executable.
472
 
    Typically, applications create subkey with their basename
 
450
    Typicaly, applications create subkey with their basename
473
451
    in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
474
452
 
475
453
    :param  appname:    name of application (if no filename extension
478
456
                or appname itself if nothing found.
479
457
    """
480
458
    import _winreg
 
459
    try:
 
460
        hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
 
461
                               r'SOFTWARE\Microsoft\Windows'
 
462
                               r'\CurrentVersion\App Paths')
 
463
    except EnvironmentError:
 
464
        return appname
481
465
 
482
466
    basename = appname
483
467
    if not os.path.splitext(basename)[1]:
484
468
        basename = appname + '.exe'
485
 
 
486
 
    try:
487
 
        hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
488
 
            'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
489
 
            basename)
490
 
    except EnvironmentError:
491
 
        return appname
492
 
 
493
469
    try:
494
470
        try:
495
 
            path, type_id = _winreg.QueryValueEx(hkey, '')
 
471
            fullpath = _winreg.QueryValue(hkey, basename)
496
472
        except WindowsError:
497
 
            return appname
 
473
            fullpath = appname
498
474
    finally:
499
475
        _winreg.CloseKey(hkey)
500
476
 
501
 
    if type_id == REG_SZ:
502
 
        return path
503
 
    if type_id == REG_EXPAND_SZ and has_win32api:
504
 
        fullpath = win32api.ExpandEnvironmentStrings(path)
505
 
        if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
506
 
            fullpath = fullpath[1:-1]   # remove quotes around value
507
 
        return fullpath
508
 
    return appname
 
477
    return fullpath
509
478
 
510
479
 
511
480
def set_file_attr_hidden(path):
512
481
    """Set file attributes to hidden if possible"""
513
482
    if has_win32file:
514
 
        if winver != 'Windows 98':
515
 
            SetFileAttributes = win32file.SetFileAttributesW
516
 
        else:
517
 
            SetFileAttributes = win32file.SetFileAttributes
518
 
        try:
519
 
            SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
520
 
        except pywintypes.error, e:
521
 
            from bzrlib import trace
522
 
            trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
523
 
 
524
 
 
525
 
 
526
 
class UnicodeShlex(object):
527
 
    """This is a very simplified version of shlex.shlex.
528
 
 
529
 
    The main change is that it supports non-ascii input streams. The internal
530
 
    structure is quite simplified relative to shlex.shlex, since we aren't
531
 
    trying to handle multiple input streams, etc. In fact, we don't use a
532
 
    file-like api either.
533
 
    """
534
 
 
535
 
    def __init__(self, uni_string):
536
 
        self._input = uni_string
537
 
        self._input_iter = iter(self._input)
538
 
        self._whitespace_match = re.compile(u'\s').match
539
 
        self._word_match = re.compile(u'\S').match
540
 
        self._quote_chars = u'"'
541
 
        # self._quote_match = re.compile(u'[\'"]').match
542
 
        self._escape_match = lambda x: None # Never matches
543
 
        self._escape = '\\'
544
 
        # State can be
545
 
        #   ' ' - after whitespace, starting a new token
546
 
        #   'a' - after text, currently working on a token
547
 
        #   '"' - after ", currently in a "-delimited quoted section
548
 
        #   "\" - after '\', checking the next char
549
 
        self._state = ' '
550
 
        self._token = [] # Current token being parsed
551
 
 
552
 
    def _get_token(self):
553
 
        # Were there quote chars as part of this token?
554
 
        quoted = False
555
 
        quoted_state = None
556
 
        for nextchar in self._input_iter:
557
 
            if self._state == ' ':
558
 
                if self._whitespace_match(nextchar):
559
 
                    # if self._token: return token
560
 
                    continue
561
 
                elif nextchar in self._quote_chars:
562
 
                    self._state = nextchar # quoted state
563
 
                elif self._word_match(nextchar):
564
 
                    self._token.append(nextchar)
565
 
                    self._state = 'a'
566
 
                else:
567
 
                    raise AssertionError('wtttf?')
568
 
            elif self._state in self._quote_chars:
569
 
                quoted = True
570
 
                if nextchar == self._state: # End of quote
571
 
                    self._state = 'a' # posix allows 'foo'bar to translate to
572
 
                                      # foobar
573
 
                elif self._state == '"' and nextchar == self._escape:
574
 
                    quoted_state = self._state
575
 
                    self._state = nextchar
576
 
                else:
577
 
                    self._token.append(nextchar)
578
 
            elif self._state == self._escape:
579
 
                if nextchar == '\\':
580
 
                    self._token.append('\\')
581
 
                elif nextchar == '"':
582
 
                    self._token.append(nextchar)
583
 
                else:
584
 
                    self._token.append('\\' + nextchar)
585
 
                self._state = quoted_state
586
 
            elif self._state == 'a':
587
 
                if self._whitespace_match(nextchar):
588
 
                    if self._token:
589
 
                        break # emit this token
590
 
                    else:
591
 
                        continue # no token to emit
592
 
                elif nextchar in self._quote_chars:
593
 
                    # Start a new quoted section
594
 
                    self._state = nextchar
595
 
                # escape?
596
 
                elif (self._word_match(nextchar)
597
 
                      or nextchar in self._quote_chars
598
 
                      # or whitespace_split?
599
 
                      ):
600
 
                    self._token.append(nextchar)
601
 
                else:
602
 
                    raise AssertionError('state == "a", char: %r'
603
 
                                         % (nextchar,))
604
 
            else:
605
 
                raise AssertionError('unknown state: %r' % (self._state,))
606
 
        result = ''.join(self._token)
607
 
        self._token = []
608
 
        if not quoted and result == '':
609
 
            result = None
610
 
        return quoted, result
611
 
 
612
 
    def __iter__(self):
613
 
        return self
614
 
 
615
 
    def next(self):
616
 
        quoted, token = self._get_token()
617
 
        if token is None:
618
 
            raise StopIteration
619
 
        return quoted, token
620
 
 
621
 
 
622
 
def _command_line_to_argv(command_line):
623
 
    """Convert a Unicode command line into a set of argv arguments.
624
 
 
625
 
    This does wildcard expansion, etc. It is intended to make wildcards act
626
 
    closer to how they work in posix shells, versus how they work by default on
627
 
    Windows.
628
 
    """
629
 
    s = UnicodeShlex(command_line)
630
 
    # Now that we've split the content, expand globs
631
 
    # TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
632
 
    #       '**/' style globs
633
 
    args = []
634
 
    for is_quoted, arg in s:
635
 
        if is_quoted or not glob.has_magic(arg):
636
 
            args.append(arg)
637
 
        else:
638
 
            args.extend(glob_one(arg))
639
 
    return args
640
 
 
641
 
 
642
 
if has_ctypes and winver != 'Windows 98':
643
 
    def get_unicode_argv():
644
 
        LPCWSTR = ctypes.c_wchar_p
645
 
        INT = ctypes.c_int
646
 
        POINTER = ctypes.POINTER
647
 
        prototype = ctypes.WINFUNCTYPE(LPCWSTR)
648
 
        GetCommandLine = prototype(("GetCommandLineW",
649
 
                                    ctypes.windll.kernel32))
650
 
        prototype = ctypes.WINFUNCTYPE(POINTER(LPCWSTR), LPCWSTR, POINTER(INT))
651
 
        command_line = GetCommandLine()
652
 
        # Skip the first argument, since we only care about parameters
653
 
        argv = _command_line_to_argv(command_line)[1:]
654
 
        if getattr(sys, 'frozen', None) is None:
655
 
            # Invoked via 'python.exe' which takes the form:
656
 
            #   python.exe [PYTHON_OPTIONS] C:\Path\bzr [BZR_OPTIONS]
657
 
            # we need to get only BZR_OPTIONS part,
658
 
            # We already removed 'python.exe' so we remove everything up to and
659
 
            # including the first non-option ('-') argument.
660
 
            for idx in xrange(len(argv)):
661
 
                if argv[idx][:1] != '-':
662
 
                    break
663
 
            argv = argv[idx+1:]
664
 
        return argv
665
 
else:
666
 
    get_unicode_argv = None
 
483
        win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)