/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/commands.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-30 22:27:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050330222717-027b5837127b938d
experiment with new nested inventory file format
not used by default yet

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
3
 
 
4
 
 
5
# This program is free software; you can redistribute it and/or modify
 
6
# it under the terms of the GNU General Public License as published by
 
7
# the Free Software Foundation; either version 2 of the License, or
 
8
# (at your option) any later version.
 
9
 
 
10
# This program is distributed in the hope that it will be useful,
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
# GNU General Public License for more details.
 
14
 
 
15
# You should have received a copy of the GNU General Public License
 
16
# along with this program; if not, write to the Free Software
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
 
19
"""Bazaar-NG -- a free distributed version-control tool
 
20
 
 
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
22
 
 
23
Current limitation include:
 
24
 
 
25
* Metadata format is not stable yet -- you may need to
 
26
  discard history in the future.
 
27
 
 
28
* Insufficient error handling.
 
29
 
 
30
* Many commands unimplemented or partially implemented.
 
31
 
 
32
* Space-inefficient storage.
 
33
 
 
34
* No merge operators yet.
 
35
 
 
36
Interesting commands::
 
37
 
 
38
  bzr help [COMMAND]
 
39
       Show help screen
 
40
  bzr version
 
41
       Show software version/licence/non-warranty.
 
42
  bzr init
 
43
       Start versioning the current directory
 
44
  bzr add FILE...
 
45
       Make files versioned.
 
46
  bzr log
 
47
       Show revision history.
 
48
  bzr diff
 
49
       Show changes from last revision to working copy.
 
50
  bzr commit -m 'MESSAGE'
 
51
       Store current state as new revision.
 
52
  bzr export REVNO DESTINATION
 
53
       Export the branch state at a previous version.
 
54
  bzr status
 
55
       Show summary of pending changes.
 
56
  bzr remove FILE...
 
57
       Make a file not versioned.
 
58
  bzr info
 
59
       Show statistics about this branch.
 
60
"""
 
61
 
 
62
 
 
63
 
 
64
 
 
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
 
66
import traceback, socket, fnmatch, difflib
 
67
from os import path
 
68
from sets import Set
 
69
from pprint import pprint
 
70
from stat import *
 
71
from glob import glob
 
72
 
 
73
import bzrlib
 
74
from bzrlib.store import ImmutableStore
 
75
from bzrlib.trace import mutter, note, log_error
 
76
from bzrlib.errors import bailout, BzrError
 
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
79
from bzrlib.revision import Revision
 
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
81
     format_date
 
82
 
 
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
85
 
 
86
## standard representation
 
87
NONE_STRING = '(none)'
 
88
EMPTY = 'empty'
 
89
 
 
90
 
 
91
## TODO: Perhaps a different version of inventory commands that
 
92
## returns iterators...
 
93
 
 
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
95
 
 
96
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
97
## parameter to the branch object saying whether we want a read or
 
98
## write lock; release it from destructor.  Perhaps don't even need a
 
99
## read lock to look at immutable objects?
 
100
 
 
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
102
## to compare output?
 
103
 
 
104
## TODO: Some kind of global code to generate the right Branch object
 
105
## to work on.  Almost, but not quite all, commands need one, and it
 
106
## can be taken either from their parameters or their working
 
107
## directory.
 
108
 
 
109
## TODO: rename command, needed soon: check destination doesn't exist
 
110
## either in working copy or tree; move working copy; update
 
111
## inventory; write out
 
112
 
 
113
## TODO: move command; check destination is a directory and will not
 
114
## clash; move it.
 
115
 
 
116
## TODO: command to show renames, one per line, as to->from
 
117
 
 
118
 
 
119
 
 
120
 
 
121
def cmd_status(all=False):
 
122
    """Display status summary.
 
123
 
 
124
    For each file there is a single line giving its file state and name.
 
125
    The name is that in the current revision unless it is deleted or
 
126
    missing, in which case the old name is shown.
 
127
 
 
128
    :todo: Don't show unchanged files unless ``--all`` is given?
 
129
    """
 
130
    Branch('.').show_status(show_all=all)
 
131
 
 
132
 
 
133
 
 
134
######################################################################
 
135
# examining history
 
136
def cmd_get_revision(revision_id):
 
137
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
138
 
 
139
 
 
140
def cmd_get_file_text(text_id):
 
141
    """Get contents of a file by hash."""
 
142
    sf = Branch('.').text_store[text_id]
 
143
    pumpfile(sf, sys.stdout)
 
144
 
 
145
 
 
146
 
 
147
######################################################################
 
148
# commands
 
149
    
 
150
 
 
151
def cmd_revno():
 
152
    """Show number of revisions on this branch"""
 
153
    print Branch('.').revno()
 
154
    
 
155
 
 
156
    
 
157
def cmd_add(file_list, verbose=False):
 
158
    """Add specified files or directories.
 
159
 
 
160
    In non-recursive mode, all the named items are added, regardless
 
161
    of whether they were previously ignored.  A warning is given if
 
162
    any of the named files are already versioned.
 
163
 
 
164
    In recursive mode (the default), files are treated the same way
 
165
    but the behaviour for directories is different.  Directories that
 
166
    are already versioned do not give a warning.  All directories,
 
167
    whether already versioned or not, are searched for files or
 
168
    subdirectories that are neither versioned or ignored, and these
 
169
    are added.  This search proceeds recursively into versioned
 
170
    directories.
 
171
 
 
172
    Therefore simply saying 'bzr add .' will version all files that
 
173
    are currently unknown.
 
174
    """
 
175
    bzrlib.add.smart_add(file_list, verbose)
 
176
    
 
177
 
 
178
def cmd_relpath(filename):
 
179
    """Show path of file relative to root"""
 
180
    print Branch(filename).relpath(filename)
 
181
 
 
182
 
 
183
def cmd_inventory(revision=None):
 
184
    """Show inventory of the current working copy."""
 
185
    ## TODO: Also optionally show a previous inventory
 
186
    ## TODO: Format options
 
187
    b = Branch('.')
 
188
    if revision == None:
 
189
        inv = b.read_working_inventory()
 
190
    else:
 
191
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
192
        
 
193
    for path, entry in inv.iter_entries():
 
194
        print '%-50s %s' % (entry.file_id, path)
 
195
 
 
196
 
 
197
 
 
198
def cmd_info():
 
199
    """info: Show statistical information for this branch
 
200
 
 
201
usage: bzr info"""
 
202
    import info
 
203
    info.show_info(Branch('.'))        
 
204
    
 
205
 
 
206
 
 
207
def cmd_remove(file_list, verbose=False):
 
208
    b = Branch(file_list[0])
 
209
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
210
 
 
211
 
 
212
 
 
213
def cmd_file_id(filename):
 
214
    b = Branch(filename)
 
215
    i = b.inventory.path2id(b.relpath(filename))
 
216
    if i is None:
 
217
        bailout("%s is not a versioned file" % filename)
 
218
    else:
 
219
        print i
 
220
 
 
221
 
 
222
def cmd_find_filename(fileid):
 
223
    n = find_filename(fileid)
 
224
    if n is None:
 
225
        bailout("%s is not a live file id" % fileid)
 
226
    else:
 
227
        print n
 
228
 
 
229
 
 
230
def cmd_revision_history():
 
231
    for patchid in Branch('.').revision_history():
 
232
        print patchid
 
233
 
 
234
 
 
235
 
 
236
def cmd_init():
 
237
    # TODO: Check we're not already in a working directory?  At the
 
238
    # moment you'll get an ugly error.
 
239
    
 
240
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
241
    # to allow that, but then the parent may need to understand that
 
242
    # the children have disappeared, or should they be versioned in
 
243
    # both?
 
244
 
 
245
    # TODO: Take an argument/option for branch name.
 
246
    Branch('.', init=True)
 
247
 
 
248
 
 
249
def cmd_diff(revision=None):
 
250
    """bzr diff: Show differences in working tree.
 
251
    
 
252
usage: bzr diff [-r REV]
 
253
 
 
254
--revision REV
 
255
    Show changes since REV, rather than predecessor.
 
256
 
 
257
TODO: Given two revision arguments, show the difference between them.
 
258
 
 
259
TODO: Allow diff across branches.
 
260
 
 
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
 
262
or a graphical diff.
 
263
 
 
264
TODO: Diff selected files.
 
265
"""
 
266
 
 
267
    ## TODO: Shouldn't be in the cmd function.
 
268
 
 
269
    b = Branch('.')
 
270
 
 
271
    if revision == None:
 
272
        old_tree = b.basis_tree()
 
273
    else:
 
274
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
275
        
 
276
    new_tree = b.working_tree()
 
277
    old_inv = old_tree.inventory
 
278
    new_inv = new_tree.inventory
 
279
 
 
280
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
281
    old_label = ''
 
282
    new_label = ''
 
283
 
 
284
    DEVNULL = '/dev/null'
 
285
    # Windows users, don't panic about this filename -- it is a
 
286
    # special signal to GNU patch that the file should be created or
 
287
    # deleted respectively.
 
288
 
 
289
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
290
    # be usefully made into a much faster special case.
 
291
 
 
292
    # TODO: Better to return them in sorted order I think.
 
293
    
 
294
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
295
        d = None
 
296
 
 
297
        # Don't show this by default; maybe do it if an option is passed
 
298
        # idlabel = '      {%s}' % fid
 
299
        idlabel = ''
 
300
 
 
301
        # FIXME: Something about the diff format makes patch unhappy
 
302
        # with newly-added files.
 
303
 
 
304
        def diffit(*a, **kw):
 
305
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
306
            print
 
307
        
 
308
        if file_state in ['.', '?', 'I']:
 
309
            continue
 
310
        elif file_state == 'A':
 
311
            print '*** added %s %r' % (kind, new_name)
 
312
            if kind == 'file':
 
313
                diffit([],
 
314
                       new_tree.get_file(fid).readlines(),
 
315
                       fromfile=DEVNULL,
 
316
                       tofile=new_label + new_name + idlabel)
 
317
        elif file_state == 'D':
 
318
            assert isinstance(old_name, types.StringTypes)
 
319
            print '*** deleted %s %r' % (kind, old_name)
 
320
            if kind == 'file':
 
321
                diffit(old_tree.get_file(fid).readlines(), [],
 
322
                       fromfile=old_label + old_name + idlabel,
 
323
                       tofile=DEVNULL)
 
324
        elif file_state in ['M', 'R']:
 
325
            if file_state == 'M':
 
326
                assert kind == 'file'
 
327
                assert old_name == new_name
 
328
                print '*** modified %s %r' % (kind, new_name)
 
329
            elif file_state == 'R':
 
330
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
331
 
 
332
            if kind == 'file':
 
333
                diffit(old_tree.get_file(fid).readlines(),
 
334
                       new_tree.get_file(fid).readlines(),
 
335
                       fromfile=old_label + old_name + idlabel,
 
336
                       tofile=new_label + new_name)
 
337
        else:
 
338
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
339
 
 
340
 
 
341
 
 
342
def cmd_deleted(show_ids=False):
 
343
    """List files deleted in the working tree.
 
344
 
 
345
TODO: Show files deleted since a previous revision, or between two revisions.
 
346
    """
 
347
    b = Branch('.')
 
348
    old = b.basis_tree()
 
349
    new = b.working_tree()
 
350
 
 
351
    ## TODO: Much more efficient way to do this: read in new
 
352
    ## directories with readdir, rather than stating each one.  Same
 
353
    ## level of effort but possibly much less IO.  (Or possibly not,
 
354
    ## if the directories are very large...)
 
355
 
 
356
    for path, ie in old.inventory.iter_entries():
 
357
        if not new.has_id(ie.file_id):
 
358
            if show_ids:
 
359
                print '%-50s %s' % (path, ie.file_id)
 
360
            else:
 
361
                print path
 
362
 
 
363
 
 
364
 
 
365
def cmd_parse_inventory():
 
366
    import cElementTree
 
367
    
 
368
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
369
 
 
370
 
 
371
 
 
372
def cmd_load_inventory():
 
373
    inv = Branch('.').basis_tree().inventory
 
374
 
 
375
 
 
376
 
 
377
def cmd_dump_new_inventory():
 
378
    import bzrlib.newinventory
 
379
    inv = Branch('.').basis_tree().inventory
 
380
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
381
                
 
382
    
 
383
def cmd_dump_slacker_inventory():
 
384
    import bzrlib.newinventory
 
385
    inv = Branch('.').basis_tree().inventory
 
386
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
387
                
 
388
    
 
389
 
 
390
def cmd_root(filename=None):
 
391
    """Print the branch root."""
 
392
    print bzrlib.branch.find_branch_root(filename)
 
393
    
 
394
 
 
395
def cmd_log(timezone='original'):
 
396
    """Show log of this branch.
 
397
 
 
398
    :todo: Options for utc; to show ids; to limit range; etc.
 
399
    """
 
400
    Branch('.').write_log(show_timezone=timezone)
 
401
 
 
402
 
 
403
def cmd_ls(revision=None, verbose=False):
 
404
    """List files in a tree.
 
405
 
 
406
    :todo: Take a revision or remote path and list that tree instead.
 
407
    """
 
408
    b = Branch('.')
 
409
    if revision == None:
 
410
        tree = b.working_tree()
 
411
    else:
 
412
        tree = b.revision_tree(b.lookup_revision(revision))
 
413
        
 
414
    for fp, fc, kind, fid in tree.list_files():
 
415
        if verbose:
 
416
            if kind == 'directory':
 
417
                kindch = '/'
 
418
            elif kind == 'file':
 
419
                kindch = ''
 
420
            else:
 
421
                kindch = '???'
 
422
                
 
423
            print '%-8s %s%s' % (fc, fp, kindch)
 
424
        else:
 
425
            print fp
 
426
    
 
427
    
 
428
 
 
429
def cmd_unknowns():
 
430
    """List unknown files"""
 
431
    for f in Branch('.').unknowns():
 
432
        print quotefn(f)
 
433
 
 
434
 
 
435
 
 
436
def cmd_ignored(verbose=True):
 
437
    """List ignored files and the patterns that matched them.
 
438
      """
 
439
    tree = Branch('.').working_tree()
 
440
    for path, file_class, kind, id in tree.list_files():
 
441
        if file_class != 'I':
 
442
            continue
 
443
        ## XXX: Slightly inefficient since this was already calculated
 
444
        pat = tree.is_ignored(path)
 
445
        print '%-50s %s' % (path, pat)
 
446
 
 
447
 
 
448
def cmd_lookup_revision(revno):
 
449
    try:
 
450
        revno = int(revno)
 
451
    except ValueError:
 
452
        bailout("usage: lookup-revision REVNO",
 
453
                ["REVNO is a non-negative revision number for this branch"])
 
454
 
 
455
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
456
 
 
457
 
 
458
 
 
459
def cmd_export(revno, dest):
 
460
    """Export past revision to destination directory."""
 
461
    b = Branch('.')
 
462
    rh = b.lookup_revision(int(revno))
 
463
    t = b.revision_tree(rh)
 
464
    t.export(dest)
 
465
 
 
466
 
 
467
 
 
468
######################################################################
 
469
# internal/test commands
 
470
 
 
471
 
 
472
def cmd_uuid():
 
473
    """Print a newly-generated UUID."""
 
474
    print bzrlib.osutils.uuid()
 
475
 
 
476
 
 
477
 
 
478
def cmd_local_time_offset():
 
479
    print bzrlib.osutils.local_time_offset()
 
480
 
 
481
 
 
482
 
 
483
def cmd_commit(message=None, verbose=False):
 
484
    """Commit changes to a new revision.
 
485
 
 
486
--message MESSAGE
 
487
    Description of changes in this revision; free form text.
 
488
    It is recommended that the first line be a single-sentence
 
489
    summary.
 
490
--verbose
 
491
    Show status of changed files,
 
492
 
 
493
TODO: Commit only selected files.
 
494
 
 
495
TODO: Run hooks on tree to-be-committed, and after commit.
 
496
 
 
497
TODO: Strict commit that fails if there are unknown or deleted files.
 
498
"""
 
499
 
 
500
    if not message:
 
501
        bailout("please specify a commit message")
 
502
    Branch('.').commit(message, verbose=verbose)
 
503
 
 
504
 
 
505
def cmd_check(dir='.'):
 
506
    """check: Consistency check of branch history.
 
507
 
 
508
usage: bzr check [-v] [BRANCH]
 
509
 
 
510
options:
 
511
  --verbose, -v         Show progress of checking.
 
512
 
 
513
This command checks various invariants about the branch storage to
 
514
detect data corruption or bzr bugs.
 
515
"""
 
516
    import bzrlib.check
 
517
    bzrlib.check.check(Branch(dir, find_root=False))
 
518
 
 
519
 
 
520
def cmd_is(pred, *rest):
 
521
    """Test whether PREDICATE is true."""
 
522
    try:
 
523
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
524
    except KeyError:
 
525
        bailout("unknown predicate: %s" % quotefn(pred))
 
526
        
 
527
    try:
 
528
        cmd_handler(*rest)
 
529
    except BzrCheckError:
 
530
        # by default we don't print the message so that this can
 
531
        # be used from shell scripts without producing noise
 
532
        sys.exit(1)
 
533
 
 
534
 
 
535
def cmd_username():
 
536
    print bzrlib.osutils.username()
 
537
 
 
538
 
 
539
def cmd_user_email():
 
540
    print bzrlib.osutils.user_email()
 
541
 
 
542
 
 
543
def cmd_gen_revision_id():
 
544
    import time
 
545
    print bzrlib.branch._gen_revision_id(time.time())
 
546
 
 
547
 
 
548
def cmd_selftest(verbose=False):
 
549
    """Run internal test suite"""
 
550
    ## -v, if present, is seen by doctest; the argument is just here
 
551
    ## so our parser doesn't complain
 
552
 
 
553
    ## TODO: --verbose option
 
554
 
 
555
    failures, tests = 0, 0
 
556
    
 
557
    import doctest, bzrlib.store, bzrlib.tests
 
558
    bzrlib.trace.verbose = False
 
559
 
 
560
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
561
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
562
        mf, mt = doctest.testmod(m)
 
563
        failures += mf
 
564
        tests += mt
 
565
        print '%-40s %3d tests' % (m.__name__, mt),
 
566
        if mf:
 
567
            print '%3d FAILED!' % mf
 
568
        else:
 
569
            print
 
570
 
 
571
    print '%-40s %3d tests' % ('total', tests),
 
572
    if failures:
 
573
        print '%3d FAILED!' % failures
 
574
    else:
 
575
        print
 
576
 
 
577
 
 
578
 
 
579
# deprecated
 
580
cmd_doctest = cmd_selftest
 
581
 
 
582
 
 
583
######################################################################
 
584
# help
 
585
 
 
586
 
 
587
def cmd_help(topic=None):
 
588
    if topic == None:
 
589
        print __doc__
 
590
        return
 
591
 
 
592
    # otherwise, maybe the name of a command?
 
593
    try:
 
594
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
 
595
    except KeyError:
 
596
        bailout("no help for %r" % topic)
 
597
 
 
598
    doc = cmdfn.__doc__
 
599
    if doc == None:
 
600
        bailout("sorry, no detailed help yet for %r" % topic)
 
601
 
 
602
    print doc
 
603
        
 
604
 
 
605
 
 
606
 
 
607
def cmd_version():
 
608
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
609
    print bzrlib.__copyright__
 
610
    print "http://bazaar-ng.org/"
 
611
    print
 
612
    print \
 
613
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
614
you may use, modify and redistribute it under the terms of the GNU 
 
615
General Public License version 2 or later."""
 
616
 
 
617
 
 
618
def cmd_rocks():
 
619
    """Statement of optimism."""
 
620
    print "it sure does!"
 
621
 
 
622
 
 
623
 
 
624
######################################################################
 
625
# main routine
 
626
 
 
627
 
 
628
# list of all available options; the rhs can be either None for an
 
629
# option that takes no argument, or a constructor function that checks
 
630
# the type.
 
631
OPTIONS = {
 
632
    'all':                    None,
 
633
    'help':                   None,
 
634
    'message':                unicode,
 
635
    'profile':                None,
 
636
    'revision':               int,
 
637
    'show-ids':               None,
 
638
    'timezone':               str,
 
639
    'verbose':                None,
 
640
    'version':                None,
 
641
    }
 
642
 
 
643
SHORT_OPTIONS = {
 
644
    'm':                      'message',
 
645
    'r':                      'revision',
 
646
    'v':                      'verbose',
 
647
}
 
648
 
 
649
# List of options that apply to particular commands; commands not
 
650
# listed take none.
 
651
cmd_options = {
 
652
    'add':                    ['verbose'],
 
653
    'commit':                 ['message', 'verbose'],
 
654
    'deleted':                ['show-ids'],
 
655
    'diff':                   ['revision'],
 
656
    'inventory':              ['revision'],
 
657
    'log':                    ['timezone'],
 
658
    'ls':                     ['revision', 'verbose'],
 
659
    'remove':                 ['verbose'],
 
660
    'status':                 ['all'],
 
661
    }
 
662
 
 
663
 
 
664
cmd_args = {
 
665
    'add':                    ['file+'],
 
666
    'commit':                 [],
 
667
    'diff':                   [],
 
668
    'export':                 ['revno', 'dest'],
 
669
    'file-id':                ['filename'],
 
670
    'get-file-text':          ['text_id'],
 
671
    'get-inventory':          ['inventory_id'],
 
672
    'get-revision':           ['revision_id'],
 
673
    'get-revision-inventory': ['revision_id'],
 
674
    'help':                   ['topic?'],
 
675
    'init':                   [],
 
676
    'log':                    [],
 
677
    'lookup-revision':        ['revno'],
 
678
    'relpath':                ['filename'],
 
679
    'remove':                 ['file+'],
 
680
    'root':                   ['filename?'],
 
681
    'status':                 [],
 
682
    }
 
683
 
 
684
 
 
685
def parse_args(argv):
 
686
    """Parse command line.
 
687
    
 
688
    Arguments and options are parsed at this level before being passed
 
689
    down to specific command handlers.  This routine knows, from a
 
690
    lookup table, something about the available options, what optargs
 
691
    they take, and which commands will accept them.
 
692
 
 
693
    >>> parse_args('--help'.split())
 
694
    ([], {'help': True})
 
695
    >>> parse_args('--version'.split())
 
696
    ([], {'version': True})
 
697
    >>> parse_args('status --all'.split())
 
698
    (['status'], {'all': True})
 
699
    >>> parse_args('commit --message=biter'.split())
 
700
    (['commit'], {'message': u'biter'})
 
701
    """
 
702
    args = []
 
703
    opts = {}
 
704
 
 
705
    # TODO: Maybe handle '--' to end options?
 
706
 
 
707
    while argv:
 
708
        a = argv.pop(0)
 
709
        if a[0] == '-':
 
710
            optarg = None
 
711
            if a[1] == '-':
 
712
                mutter("  got option %r" % a)
 
713
                if '=' in a:
 
714
                    optname, optarg = a[2:].split('=', 1)
 
715
                else:
 
716
                    optname = a[2:]
 
717
                if optname not in OPTIONS:
 
718
                    bailout('unknown long option %r' % a)
 
719
            else:
 
720
                shortopt = a[1:]
 
721
                if shortopt not in SHORT_OPTIONS:
 
722
                    bailout('unknown short option %r' % a)
 
723
                optname = SHORT_OPTIONS[shortopt]
 
724
            
 
725
            if optname in opts:
 
726
                # XXX: Do we ever want to support this, e.g. for -r?
 
727
                bailout('repeated option %r' % a)
 
728
                
 
729
            optargfn = OPTIONS[optname]
 
730
            if optargfn:
 
731
                if optarg == None:
 
732
                    if not argv:
 
733
                        bailout('option %r needs an argument' % a)
 
734
                    else:
 
735
                        optarg = argv.pop(0)
 
736
                opts[optname] = optargfn(optarg)
 
737
            else:
 
738
                if optarg != None:
 
739
                    bailout('option %r takes no argument' % optname)
 
740
                opts[optname] = True
 
741
        else:
 
742
            args.append(a)
 
743
 
 
744
    return args, opts
 
745
 
 
746
 
 
747
 
 
748
def _match_args(cmd, args):
 
749
    """Check non-option arguments match required pattern.
 
750
 
 
751
    >>> _match_args('status', ['asdasdsadasd'])
 
752
    Traceback (most recent call last):
 
753
    ...
 
754
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
755
    >>> _match_args('add', ['asdasdsadasd'])
 
756
    {'file_list': ['asdasdsadasd']}
 
757
    >>> _match_args('add', 'abc def gj'.split())
 
758
    {'file_list': ['abc', 'def', 'gj']}
 
759
    """
 
760
    # match argument pattern
 
761
    argform = cmd_args.get(cmd, [])
 
762
    argdict = {}
 
763
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
764
    # all but one.
 
765
 
 
766
    # step through args and argform, allowing appropriate 0-many matches
 
767
    for ap in argform:
 
768
        argname = ap[:-1]
 
769
        if ap[-1] == '?':
 
770
            if args:
 
771
                argdict[argname] = args.pop(0)
 
772
        elif ap[-1] == '*':
 
773
            assert 0
 
774
        elif ap[-1] == '+':
 
775
            if not args:
 
776
                bailout("command %r needs one or more %s"
 
777
                        % (cmd, argname.upper()))
 
778
            else:
 
779
                argdict[argname + '_list'] = args[:]
 
780
                args = []
 
781
        else:
 
782
            # just a plain arg
 
783
            argname = ap
 
784
            if not args:
 
785
                bailout("command %r requires argument %s"
 
786
                        % (cmd, argname.upper()))
 
787
            else:
 
788
                argdict[argname] = args.pop(0)
 
789
            
 
790
    if args:
 
791
        bailout("extra arguments to command %s: %r"
 
792
                % (cmd, args))
 
793
 
 
794
    return argdict
 
795
 
 
796
 
 
797
 
 
798
def run_bzr(argv):
 
799
    """Execute a command.
 
800
 
 
801
    This is similar to main(), but without all the trappings for
 
802
    logging and error handling.
 
803
    """
 
804
    try:
 
805
        args, opts = parse_args(argv[1:])
 
806
        if 'help' in opts:
 
807
            # TODO: pass down other arguments in case they asked for
 
808
            # help on a command name?
 
809
            cmd_help()
 
810
            return 0
 
811
        elif 'version' in opts:
 
812
            cmd_version()
 
813
            return 0
 
814
        cmd = args.pop(0)
 
815
    except IndexError:
 
816
        log_error('usage: bzr COMMAND\n')
 
817
        log_error('  try "bzr help"\n')
 
818
        return 1
 
819
 
 
820
    try:
 
821
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
822
    except KeyError:
 
823
        bailout("unknown command " + `cmd`)
 
824
 
 
825
    # global option
 
826
    if 'profile' in opts:
 
827
        profile = True
 
828
        del opts['profile']
 
829
    else:
 
830
        profile = False
 
831
 
 
832
    # check options are reasonable
 
833
    allowed = cmd_options.get(cmd, [])
 
834
    for oname in opts:
 
835
        if oname not in allowed:
 
836
            bailout("option %r is not allowed for command %r"
 
837
                    % (oname, cmd))
 
838
 
 
839
    # mix arguments and options into one dictionary
 
840
    cmdargs = _match_args(cmd, args)
 
841
    for k, v in opts.items():
 
842
        cmdargs[k.replace('-', '_')] = v
 
843
 
 
844
    if profile:
 
845
        import hotshot
 
846
        prof = hotshot.Profile('.bzr.profile')
 
847
        ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
848
        prof.close()
 
849
 
 
850
        import hotshot.stats
 
851
        stats = hotshot.stats.load('.bzr.profile')
 
852
        #stats.strip_dirs()
 
853
        stats.sort_stats('time')
 
854
        stats.print_stats(20)
 
855
    else:
 
856
        return cmd_handler(**cmdargs) or 0
 
857
 
 
858
 
 
859
 
 
860
def main(argv):
 
861
    ## TODO: Handle command-line options; probably know what options are valid for
 
862
    ## each command
 
863
 
 
864
    ## TODO: If the arguments are wrong, give a usage message rather
 
865
    ## than just a backtrace.
 
866
 
 
867
    bzrlib.trace.create_tracefile(argv)
 
868
    
 
869
    try:
 
870
        ret = run_bzr(argv)
 
871
        return ret
 
872
    except BzrError, e:
 
873
        log_error('bzr: error: ' + e.args[0] + '\n')
 
874
        if len(e.args) > 1:
 
875
            for h in e.args[1]:
 
876
                log_error('  ' + h + '\n')
 
877
        return 1
 
878
    except Exception, e:
 
879
        log_error('bzr: exception: %s\n' % e)
 
880
        log_error('    see .bzr.log for details\n')
 
881
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
882
        traceback.print_exc(None, sys.stderr)
 
883
        return 1
 
884
 
 
885
    # TODO: Maybe nicer handling of IOError?
 
886
 
 
887
 
 
888
 
 
889
if __name__ == '__main__':
 
890
    sys.exit(main(sys.argv))
 
891
    ##import profile
 
892
    ##profile.run('main(sys.argv)')
 
893