/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-05-27 17:59:18 UTC
  • mfrom: (4797.43.14 2.1)
  • mto: This revision was merged to the branch mainline in revision 5264.
  • Revision ID: robertc@robertcollins.net-20100527175918-un0gcxr0n9or5tb3
Tags: bzr-2.2b3
Release 2.2b3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1400
1400
terminal_width() returns None.
1401
1401
"""
1402
1402
 
 
1403
# Keep some state so that terminal_width can detect if _terminal_size has
 
1404
# returned a different size since the process started.  See docstring and
 
1405
# comments of terminal_width for details.
 
1406
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1407
_terminal_size_state = 'no_data'
 
1408
_first_terminal_size = None
1403
1409
 
1404
1410
def terminal_width():
1405
1411
    """Return terminal width.
1409
1415
    The rules are:
1410
1416
    - if BZR_COLUMNS is set, returns its value
1411
1417
    - if there is no controlling terminal, returns None
 
1418
    - query the OS, if the queried size has changed since the last query,
 
1419
      return its value,
1412
1420
    - if COLUMNS is set, returns its value,
 
1421
    - if the OS has a value (even though it's never changed), return its value.
1413
1422
 
1414
1423
    From there, we need to query the OS to get the size of the controlling
1415
1424
    terminal.
1416
1425
 
1417
 
    Unices:
 
1426
    On Unices we query the OS by:
1418
1427
    - get termios.TIOCGWINSZ
1419
1428
    - if an error occurs or a negative value is obtained, returns None
1420
1429
 
1421
 
    Windows:
1422
 
    
 
1430
    On Windows we query the OS by:
1423
1431
    - win32utils.get_console_size() decides,
1424
1432
    - returns None on error (provided default value)
1425
1433
    """
 
1434
    # Note to implementors: if changing the rules for determining the width,
 
1435
    # make sure you've considered the behaviour in these cases:
 
1436
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1437
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1438
    #    0,0.
 
1439
    #  - (add more interesting cases here, if you find any)
 
1440
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1441
    # but we don't want to register a signal handler because it is impossible
 
1442
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1443
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1444
    # time so we can notice if the reported size has changed, which should have
 
1445
    # a similar effect.
1426
1446
 
1427
1447
    # If BZR_COLUMNS is set, take it, user is always right
1428
1448
    try:
1431
1451
        pass
1432
1452
 
1433
1453
    isatty = getattr(sys.stdout, 'isatty', None)
1434
 
    if  isatty is None or not isatty():
 
1454
    if isatty is None or not isatty():
1435
1455
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1436
1456
        return None
1437
1457
 
1438
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1439
 
    # given terminal, the application can decide to set COLUMNS to a lower
1440
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1458
    # Query the OS
 
1459
    width, height = os_size = _terminal_size(None, None)
 
1460
    global _first_terminal_size, _terminal_size_state
 
1461
    if _terminal_size_state == 'no_data':
 
1462
        _first_terminal_size = os_size
 
1463
        _terminal_size_state = 'unchanged'
 
1464
    elif (_terminal_size_state == 'unchanged' and
 
1465
          _first_terminal_size != os_size):
 
1466
        _terminal_size_state = 'changed'
 
1467
 
 
1468
    # If the OS claims to know how wide the terminal is, and this value has
 
1469
    # ever changed, use that.
 
1470
    if _terminal_size_state == 'changed':
 
1471
        if width is not None and width > 0:
 
1472
            return width
 
1473
 
 
1474
    # If COLUMNS is set, use it.
1441
1475
    try:
1442
1476
        return int(os.environ['COLUMNS'])
1443
1477
    except (KeyError, ValueError):
1444
1478
        pass
1445
1479
 
1446
 
    width, height = _terminal_size(None, None)
1447
 
    if width <= 0:
1448
 
        # Consider invalid values as meaning no width
1449
 
        return None
 
1480
    # Finally, use an unchanged size from the OS, if we have one.
 
1481
    if _terminal_size_state == 'unchanged':
 
1482
        if width is not None and width > 0:
 
1483
            return width
1450
1484
 
1451
 
    return width
 
1485
    # The width could not be determined.
 
1486
    return None
1452
1487
 
1453
1488
 
1454
1489
def _win32_terminal_size(width, height):
1481
1516
    _terminal_size = _ioctl_terminal_size
1482
1517
 
1483
1518
 
1484
 
def _terminal_size_changed(signum, frame):
1485
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1486
 
    width, height = _terminal_size(None, None)
1487
 
    if width is not None:
1488
 
        os.environ['COLUMNS'] = str(width)
1489
 
 
1490
 
 
1491
 
_registered_sigwinch = False
1492
 
def watch_sigwinch():
1493
 
    """Register for SIGWINCH, once and only once.
1494
 
 
1495
 
    Do nothing if the signal module is not available.
1496
 
    """
1497
 
    global _registered_sigwinch
1498
 
    if not _registered_sigwinch:
1499
 
        try:
1500
 
            import signal
1501
 
            if getattr(signal, "SIGWINCH", None) is not None:
1502
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1503
 
        except ImportError:
1504
 
            # python doesn't provide signal support, nothing we can do about it
1505
 
            pass
1506
 
        _registered_sigwinch = True
1507
 
 
1508
 
 
1509
1519
def supports_executable():
1510
1520
    return sys.platform != "win32"
1511
1521