/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-04-01 08:22:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050401082211-da0a0e8911740407
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think

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
 
 
184
def cmd_inventory(revision=None):
 
185
    """Show inventory of the current working copy."""
 
186
    ## TODO: Also optionally show a previous inventory
 
187
    ## TODO: Format options
 
188
    b = Branch('.')
 
189
    if revision == None:
 
190
        inv = b.read_working_inventory()
 
191
    else:
 
192
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
193
        
 
194
    for path, entry in inv.iter_entries():
 
195
        print '%-50s %s' % (entry.file_id, path)
 
196
 
 
197
 
 
198
 
 
199
def cmd_mv(source_list, dest):
 
200
    b = Branch('.')
 
201
 
 
202
    b.rename([b.relpath(s) for s in source_list], b.relpath(dest))
 
203
 
 
204
 
 
205
 
 
206
def cmd_info():
 
207
    """info: Show statistical information for this branch
 
208
 
 
209
usage: bzr info"""
 
210
    import info
 
211
    info.show_info(Branch('.'))        
 
212
    
 
213
 
 
214
 
 
215
def cmd_remove(file_list, verbose=False):
 
216
    b = Branch(file_list[0])
 
217
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
218
 
 
219
 
 
220
 
 
221
def cmd_file_id(filename):
 
222
    b = Branch(filename)
 
223
    i = b.inventory.path2id(b.relpath(filename))
 
224
    if i is None:
 
225
        bailout("%s is not a versioned file" % filename)
 
226
    else:
 
227
        print i
 
228
 
 
229
 
 
230
def cmd_find_filename(fileid):
 
231
    n = find_filename(fileid)
 
232
    if n is None:
 
233
        bailout("%s is not a live file id" % fileid)
 
234
    else:
 
235
        print n
 
236
 
 
237
 
 
238
def cmd_revision_history():
 
239
    for patchid in Branch('.').revision_history():
 
240
        print patchid
 
241
 
 
242
 
 
243
def cmd_directories():
 
244
    for name, ie in Branch('.').read_working_inventory().directories():
 
245
        if name == '':
 
246
            print '.'
 
247
        else:
 
248
            print name
 
249
 
 
250
 
 
251
def cmd_missing():
 
252
    for name, ie in Branch('.').working_tree().missing():
 
253
        print name
 
254
 
 
255
 
 
256
def cmd_init():
 
257
    # TODO: Check we're not already in a working directory?  At the
 
258
    # moment you'll get an ugly error.
 
259
    
 
260
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
261
    # to allow that, but then the parent may need to understand that
 
262
    # the children have disappeared, or should they be versioned in
 
263
    # both?
 
264
 
 
265
    # TODO: Take an argument/option for branch name.
 
266
    Branch('.', init=True)
 
267
 
 
268
 
 
269
def cmd_diff(revision=None):
 
270
    """bzr diff: Show differences in working tree.
 
271
    
 
272
usage: bzr diff [-r REV]
 
273
 
 
274
--revision REV
 
275
    Show changes since REV, rather than predecessor.
 
276
 
 
277
TODO: Given two revision arguments, show the difference between them.
 
278
 
 
279
TODO: Allow diff across branches.
 
280
 
 
281
TODO: Option to use external diff command; could be GNU diff, wdiff,
 
282
or a graphical diff.
 
283
 
 
284
TODO: Diff selected files.
 
285
"""
 
286
 
 
287
    ## TODO: Shouldn't be in the cmd function.
 
288
 
 
289
    b = Branch('.')
 
290
 
 
291
    if revision == None:
 
292
        old_tree = b.basis_tree()
 
293
    else:
 
294
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
295
        
 
296
    new_tree = b.working_tree()
 
297
    old_inv = old_tree.inventory
 
298
    new_inv = new_tree.inventory
 
299
 
 
300
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
301
    old_label = ''
 
302
    new_label = ''
 
303
 
 
304
    DEVNULL = '/dev/null'
 
305
    # Windows users, don't panic about this filename -- it is a
 
306
    # special signal to GNU patch that the file should be created or
 
307
    # deleted respectively.
 
308
 
 
309
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
310
    # be usefully made into a much faster special case.
 
311
 
 
312
    # TODO: Better to return them in sorted order I think.
 
313
    
 
314
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
315
        d = None
 
316
 
 
317
        # Don't show this by default; maybe do it if an option is passed
 
318
        # idlabel = '      {%s}' % fid
 
319
        idlabel = ''
 
320
 
 
321
        # FIXME: Something about the diff format makes patch unhappy
 
322
        # with newly-added files.
 
323
 
 
324
        def diffit(*a, **kw):
 
325
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
326
            print
 
327
        
 
328
        if file_state in ['.', '?', 'I']:
 
329
            continue
 
330
        elif file_state == 'A':
 
331
            print '*** added %s %r' % (kind, new_name)
 
332
            if kind == 'file':
 
333
                diffit([],
 
334
                       new_tree.get_file(fid).readlines(),
 
335
                       fromfile=DEVNULL,
 
336
                       tofile=new_label + new_name + idlabel)
 
337
        elif file_state == 'D':
 
338
            assert isinstance(old_name, types.StringTypes)
 
339
            print '*** deleted %s %r' % (kind, old_name)
 
340
            if kind == 'file':
 
341
                diffit(old_tree.get_file(fid).readlines(), [],
 
342
                       fromfile=old_label + old_name + idlabel,
 
343
                       tofile=DEVNULL)
 
344
        elif file_state in ['M', 'R']:
 
345
            if file_state == 'M':
 
346
                assert kind == 'file'
 
347
                assert old_name == new_name
 
348
                print '*** modified %s %r' % (kind, new_name)
 
349
            elif file_state == 'R':
 
350
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
351
 
 
352
            if kind == 'file':
 
353
                diffit(old_tree.get_file(fid).readlines(),
 
354
                       new_tree.get_file(fid).readlines(),
 
355
                       fromfile=old_label + old_name + idlabel,
 
356
                       tofile=new_label + new_name)
 
357
        else:
 
358
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
359
 
 
360
 
 
361
 
 
362
def cmd_deleted(show_ids=False):
 
363
    """List files deleted in the working tree.
 
364
 
 
365
TODO: Show files deleted since a previous revision, or between two revisions.
 
366
    """
 
367
    b = Branch('.')
 
368
    old = b.basis_tree()
 
369
    new = b.working_tree()
 
370
 
 
371
    ## TODO: Much more efficient way to do this: read in new
 
372
    ## directories with readdir, rather than stating each one.  Same
 
373
    ## level of effort but possibly much less IO.  (Or possibly not,
 
374
    ## if the directories are very large...)
 
375
 
 
376
    for path, ie in old.inventory.iter_entries():
 
377
        if not new.has_id(ie.file_id):
 
378
            if show_ids:
 
379
                print '%-50s %s' % (path, ie.file_id)
 
380
            else:
 
381
                print path
 
382
 
 
383
 
 
384
 
 
385
def cmd_parse_inventory():
 
386
    import cElementTree
 
387
    
 
388
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
389
 
 
390
 
 
391
 
 
392
def cmd_load_inventory():
 
393
    inv = Branch('.').basis_tree().inventory
 
394
 
 
395
 
 
396
 
 
397
def cmd_dump_new_inventory():
 
398
    import bzrlib.newinventory
 
399
    inv = Branch('.').basis_tree().inventory
 
400
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
401
 
 
402
 
 
403
def cmd_load_new_inventory():
 
404
    import bzrlib.newinventory
 
405
    bzrlib.newinventory.read_new_inventory(sys.stdin)
 
406
                
 
407
    
 
408
def cmd_dump_slacker_inventory():
 
409
    import bzrlib.newinventory
 
410
    inv = Branch('.').basis_tree().inventory
 
411
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
412
                
 
413
    
 
414
 
 
415
def cmd_root(filename=None):
 
416
    """Print the branch root."""
 
417
    print bzrlib.branch.find_branch_root(filename)
 
418
    
 
419
 
 
420
def cmd_log(timezone='original'):
 
421
    """Show log of this branch.
 
422
 
 
423
    :todo: Options for utc; to show ids; to limit range; etc.
 
424
    """
 
425
    Branch('.').write_log(show_timezone=timezone)
 
426
 
 
427
 
 
428
def cmd_ls(revision=None, verbose=False):
 
429
    """List files in a tree.
 
430
 
 
431
    :todo: Take a revision or remote path and list that tree instead.
 
432
    """
 
433
    b = Branch('.')
 
434
    if revision == None:
 
435
        tree = b.working_tree()
 
436
    else:
 
437
        tree = b.revision_tree(b.lookup_revision(revision))
 
438
        
 
439
    for fp, fc, kind, fid in tree.list_files():
 
440
        if verbose:
 
441
            if kind == 'directory':
 
442
                kindch = '/'
 
443
            elif kind == 'file':
 
444
                kindch = ''
 
445
            else:
 
446
                kindch = '???'
 
447
                
 
448
            print '%-8s %s%s' % (fc, fp, kindch)
 
449
        else:
 
450
            print fp
 
451
    
 
452
    
 
453
 
 
454
def cmd_unknowns():
 
455
    """List unknown files"""
 
456
    for f in Branch('.').unknowns():
 
457
        print quotefn(f)
 
458
 
 
459
 
 
460
 
 
461
def cmd_ignored(verbose=True):
 
462
    """List ignored files and the patterns that matched them.
 
463
      """
 
464
    tree = Branch('.').working_tree()
 
465
    for path, file_class, kind, id in tree.list_files():
 
466
        if file_class != 'I':
 
467
            continue
 
468
        ## XXX: Slightly inefficient since this was already calculated
 
469
        pat = tree.is_ignored(path)
 
470
        print '%-50s %s' % (path, pat)
 
471
 
 
472
 
 
473
def cmd_lookup_revision(revno):
 
474
    try:
 
475
        revno = int(revno)
 
476
    except ValueError:
 
477
        bailout("usage: lookup-revision REVNO",
 
478
                ["REVNO is a non-negative revision number for this branch"])
 
479
 
 
480
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
481
 
 
482
 
 
483
 
 
484
def cmd_export(revno, dest):
 
485
    """Export past revision to destination directory."""
 
486
    b = Branch('.')
 
487
    rh = b.lookup_revision(int(revno))
 
488
    t = b.revision_tree(rh)
 
489
    t.export(dest)
 
490
 
 
491
 
 
492
 
 
493
######################################################################
 
494
# internal/test commands
 
495
 
 
496
 
 
497
def cmd_uuid():
 
498
    """Print a newly-generated UUID."""
 
499
    print bzrlib.osutils.uuid()
 
500
 
 
501
 
 
502
 
 
503
def cmd_local_time_offset():
 
504
    print bzrlib.osutils.local_time_offset()
 
505
 
 
506
 
 
507
 
 
508
def cmd_commit(message=None, verbose=False):
 
509
    """Commit changes to a new revision.
 
510
 
 
511
--message MESSAGE
 
512
    Description of changes in this revision; free form text.
 
513
    It is recommended that the first line be a single-sentence
 
514
    summary.
 
515
--verbose
 
516
    Show status of changed files,
 
517
 
 
518
TODO: Commit only selected files.
 
519
 
 
520
TODO: Run hooks on tree to-be-committed, and after commit.
 
521
 
 
522
TODO: Strict commit that fails if there are unknown or deleted files.
 
523
"""
 
524
 
 
525
    if not message:
 
526
        bailout("please specify a commit message")
 
527
    Branch('.').commit(message, verbose=verbose)
 
528
 
 
529
 
 
530
def cmd_check(dir='.'):
 
531
    """check: Consistency check of branch history.
 
532
 
 
533
usage: bzr check [-v] [BRANCH]
 
534
 
 
535
options:
 
536
  --verbose, -v         Show progress of checking.
 
537
 
 
538
This command checks various invariants about the branch storage to
 
539
detect data corruption or bzr bugs.
 
540
"""
 
541
    import bzrlib.check
 
542
    bzrlib.check.check(Branch(dir, find_root=False))
 
543
 
 
544
 
 
545
def cmd_is(pred, *rest):
 
546
    """Test whether PREDICATE is true."""
 
547
    try:
 
548
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
549
    except KeyError:
 
550
        bailout("unknown predicate: %s" % quotefn(pred))
 
551
        
 
552
    try:
 
553
        cmd_handler(*rest)
 
554
    except BzrCheckError:
 
555
        # by default we don't print the message so that this can
 
556
        # be used from shell scripts without producing noise
 
557
        sys.exit(1)
 
558
 
 
559
 
 
560
def cmd_username():
 
561
    print bzrlib.osutils.username()
 
562
 
 
563
 
 
564
def cmd_user_email():
 
565
    print bzrlib.osutils.user_email()
 
566
 
 
567
 
 
568
def cmd_gen_revision_id():
 
569
    import time
 
570
    print bzrlib.branch._gen_revision_id(time.time())
 
571
 
 
572
 
 
573
def cmd_selftest(verbose=False):
 
574
    """Run internal test suite"""
 
575
    ## -v, if present, is seen by doctest; the argument is just here
 
576
    ## so our parser doesn't complain
 
577
 
 
578
    ## TODO: --verbose option
 
579
 
 
580
    failures, tests = 0, 0
 
581
    
 
582
    import doctest, bzrlib.store, bzrlib.tests
 
583
    bzrlib.trace.verbose = False
 
584
 
 
585
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
586
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
587
        mf, mt = doctest.testmod(m)
 
588
        failures += mf
 
589
        tests += mt
 
590
        print '%-40s %3d tests' % (m.__name__, mt),
 
591
        if mf:
 
592
            print '%3d FAILED!' % mf
 
593
        else:
 
594
            print
 
595
 
 
596
    print '%-40s %3d tests' % ('total', tests),
 
597
    if failures:
 
598
        print '%3d FAILED!' % failures
 
599
    else:
 
600
        print
 
601
 
 
602
 
 
603
 
 
604
# deprecated
 
605
cmd_doctest = cmd_selftest
 
606
 
 
607
 
 
608
######################################################################
 
609
# help
 
610
 
 
611
 
 
612
def cmd_help(topic=None):
 
613
    if topic == None:
 
614
        print __doc__
 
615
        return
 
616
 
 
617
    # otherwise, maybe the name of a command?
 
618
    try:
 
619
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
 
620
    except KeyError:
 
621
        bailout("no help for %r" % topic)
 
622
 
 
623
    doc = cmdfn.__doc__
 
624
    if doc == None:
 
625
        bailout("sorry, no detailed help yet for %r" % topic)
 
626
 
 
627
    print doc
 
628
        
 
629
 
 
630
 
 
631
 
 
632
def cmd_version():
 
633
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
634
    print bzrlib.__copyright__
 
635
    print "http://bazaar-ng.org/"
 
636
    print
 
637
    print \
 
638
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
639
you may use, modify and redistribute it under the terms of the GNU 
 
640
General Public License version 2 or later."""
 
641
 
 
642
 
 
643
def cmd_rocks():
 
644
    """Statement of optimism."""
 
645
    print "it sure does!"
 
646
 
 
647
 
 
648
 
 
649
######################################################################
 
650
# main routine
 
651
 
 
652
 
 
653
# list of all available options; the rhs can be either None for an
 
654
# option that takes no argument, or a constructor function that checks
 
655
# the type.
 
656
OPTIONS = {
 
657
    'all':                    None,
 
658
    'help':                   None,
 
659
    'message':                unicode,
 
660
    'profile':                None,
 
661
    'revision':               int,
 
662
    'show-ids':               None,
 
663
    'timezone':               str,
 
664
    'verbose':                None,
 
665
    'version':                None,
 
666
    }
 
667
 
 
668
SHORT_OPTIONS = {
 
669
    'm':                      'message',
 
670
    'r':                      'revision',
 
671
    'v':                      'verbose',
 
672
}
 
673
 
 
674
# List of options that apply to particular commands; commands not
 
675
# listed take none.
 
676
cmd_options = {
 
677
    'add':                    ['verbose'],
 
678
    'commit':                 ['message', 'verbose'],
 
679
    'deleted':                ['show-ids'],
 
680
    'diff':                   ['revision'],
 
681
    'inventory':              ['revision'],
 
682
    'log':                    ['timezone'],
 
683
    'ls':                     ['revision', 'verbose'],
 
684
    'remove':                 ['verbose'],
 
685
    'status':                 ['all'],
 
686
    }
 
687
 
 
688
 
 
689
cmd_args = {
 
690
    'add':                    ['file+'],
 
691
    'commit':                 [],
 
692
    'diff':                   [],
 
693
    'export':                 ['revno', 'dest'],
 
694
    'file-id':                ['filename'],
 
695
    'get-file-text':          ['text_id'],
 
696
    'get-inventory':          ['inventory_id'],
 
697
    'get-revision':           ['revision_id'],
 
698
    'get-revision-inventory': ['revision_id'],
 
699
    'help':                   ['topic?'],
 
700
    'init':                   [],
 
701
    'log':                    [],
 
702
    'lookup-revision':        ['revno'],
 
703
    'mv':                     ['source$', 'dest'],
 
704
    'relpath':                ['filename'],
 
705
    'remove':                 ['file+'],
 
706
    'root':                   ['filename?'],
 
707
    'status':                 [],
 
708
    }
 
709
 
 
710
 
 
711
def parse_args(argv):
 
712
    """Parse command line.
 
713
    
 
714
    Arguments and options are parsed at this level before being passed
 
715
    down to specific command handlers.  This routine knows, from a
 
716
    lookup table, something about the available options, what optargs
 
717
    they take, and which commands will accept them.
 
718
 
 
719
    >>> parse_args('--help'.split())
 
720
    ([], {'help': True})
 
721
    >>> parse_args('--version'.split())
 
722
    ([], {'version': True})
 
723
    >>> parse_args('status --all'.split())
 
724
    (['status'], {'all': True})
 
725
    >>> parse_args('commit --message=biter'.split())
 
726
    (['commit'], {'message': u'biter'})
 
727
    """
 
728
    args = []
 
729
    opts = {}
 
730
 
 
731
    # TODO: Maybe handle '--' to end options?
 
732
 
 
733
    while argv:
 
734
        a = argv.pop(0)
 
735
        if a[0] == '-':
 
736
            optarg = None
 
737
            if a[1] == '-':
 
738
                mutter("  got option %r" % a)
 
739
                if '=' in a:
 
740
                    optname, optarg = a[2:].split('=', 1)
 
741
                else:
 
742
                    optname = a[2:]
 
743
                if optname not in OPTIONS:
 
744
                    bailout('unknown long option %r' % a)
 
745
            else:
 
746
                shortopt = a[1:]
 
747
                if shortopt not in SHORT_OPTIONS:
 
748
                    bailout('unknown short option %r' % a)
 
749
                optname = SHORT_OPTIONS[shortopt]
 
750
            
 
751
            if optname in opts:
 
752
                # XXX: Do we ever want to support this, e.g. for -r?
 
753
                bailout('repeated option %r' % a)
 
754
                
 
755
            optargfn = OPTIONS[optname]
 
756
            if optargfn:
 
757
                if optarg == None:
 
758
                    if not argv:
 
759
                        bailout('option %r needs an argument' % a)
 
760
                    else:
 
761
                        optarg = argv.pop(0)
 
762
                opts[optname] = optargfn(optarg)
 
763
            else:
 
764
                if optarg != None:
 
765
                    bailout('option %r takes no argument' % optname)
 
766
                opts[optname] = True
 
767
        else:
 
768
            args.append(a)
 
769
 
 
770
    return args, opts
 
771
 
 
772
 
 
773
 
 
774
def _match_args(cmd, args):
 
775
    """Check non-option arguments match required pattern.
 
776
 
 
777
    >>> _match_args('status', ['asdasdsadasd'])
 
778
    Traceback (most recent call last):
 
779
    ...
 
780
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
781
    >>> _match_args('add', ['asdasdsadasd'])
 
782
    {'file_list': ['asdasdsadasd']}
 
783
    >>> _match_args('add', 'abc def gj'.split())
 
784
    {'file_list': ['abc', 'def', 'gj']}
 
785
    """
 
786
    # match argument pattern
 
787
    argform = cmd_args.get(cmd, [])
 
788
    argdict = {}
 
789
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
790
    # all but one.
 
791
 
 
792
    # step through args and argform, allowing appropriate 0-many matches
 
793
    for ap in argform:
 
794
        argname = ap[:-1]
 
795
        if ap[-1] == '?':
 
796
            if args:
 
797
                argdict[argname] = args.pop(0)
 
798
        elif ap[-1] == '*':
 
799
            assert 0
 
800
        elif ap[-1] == '+':
 
801
            if not args:
 
802
                bailout("command %r needs one or more %s"
 
803
                        % (cmd, argname.upper()))
 
804
            else:
 
805
                argdict[argname + '_list'] = args[:]
 
806
                args = []
 
807
        elif ap[-1] == '$': # all but one
 
808
            if len(args) < 2:
 
809
                bailout("command %r needs one or more %s"
 
810
                        % (cmd, argname.upper()))
 
811
            argdict[argname + '_list'] = args[:-1]
 
812
            args[:-1] = []                
 
813
        else:
 
814
            # just a plain arg
 
815
            argname = ap
 
816
            if not args:
 
817
                bailout("command %r requires argument %s"
 
818
                        % (cmd, argname.upper()))
 
819
            else:
 
820
                argdict[argname] = args.pop(0)
 
821
            
 
822
    if args:
 
823
        bailout("extra arguments to command %s: %r"
 
824
                % (cmd, args))
 
825
 
 
826
    return argdict
 
827
 
 
828
 
 
829
 
 
830
def run_bzr(argv):
 
831
    """Execute a command.
 
832
 
 
833
    This is similar to main(), but without all the trappings for
 
834
    logging and error handling.
 
835
    """
 
836
    try:
 
837
        args, opts = parse_args(argv[1:])
 
838
        if 'help' in opts:
 
839
            # TODO: pass down other arguments in case they asked for
 
840
            # help on a command name?
 
841
            if args:
 
842
                cmd_help(args[0])
 
843
            else:
 
844
                cmd_help()
 
845
            return 0
 
846
        elif 'version' in opts:
 
847
            cmd_version()
 
848
            return 0
 
849
        cmd = args.pop(0)
 
850
    except IndexError:
 
851
        log_error('usage: bzr COMMAND\n')
 
852
        log_error('  try "bzr help"\n')
 
853
        return 1
 
854
 
 
855
    try:
 
856
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
857
    except KeyError:
 
858
        bailout("unknown command " + `cmd`)
 
859
 
 
860
    # global option
 
861
    if 'profile' in opts:
 
862
        profile = True
 
863
        del opts['profile']
 
864
    else:
 
865
        profile = False
 
866
 
 
867
    # check options are reasonable
 
868
    allowed = cmd_options.get(cmd, [])
 
869
    for oname in opts:
 
870
        if oname not in allowed:
 
871
            bailout("option %r is not allowed for command %r"
 
872
                    % (oname, cmd))
 
873
 
 
874
    # mix arguments and options into one dictionary
 
875
    cmdargs = _match_args(cmd, args)
 
876
    for k, v in opts.items():
 
877
        cmdargs[k.replace('-', '_')] = v
 
878
 
 
879
    if profile:
 
880
        import hotshot
 
881
        prof = hotshot.Profile('.bzr.profile')
 
882
        ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
883
        prof.close()
 
884
 
 
885
        import hotshot.stats
 
886
        stats = hotshot.stats.load('.bzr.profile')
 
887
        #stats.strip_dirs()
 
888
        stats.sort_stats('time')
 
889
        stats.print_stats(20)
 
890
    else:
 
891
        return cmd_handler(**cmdargs) or 0
 
892
 
 
893
 
 
894
 
 
895
def main(argv):
 
896
    ## TODO: Handle command-line options; probably know what options are valid for
 
897
    ## each command
 
898
 
 
899
    ## TODO: If the arguments are wrong, give a usage message rather
 
900
    ## than just a backtrace.
 
901
 
 
902
    bzrlib.trace.create_tracefile(argv)
 
903
    
 
904
    try:
 
905
        ret = run_bzr(argv)
 
906
        return ret
 
907
    except BzrError, e:
 
908
        log_error('bzr: error: ' + e.args[0] + '\n')
 
909
        if len(e.args) > 1:
 
910
            for h in e.args[1]:
 
911
                log_error('  ' + h + '\n')
 
912
        return 1
 
913
    except Exception, e:
 
914
        log_error('bzr: exception: %s\n' % e)
 
915
        log_error('    see .bzr.log for details\n')
 
916
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
917
        traceback.print_exc(None, sys.stderr)
 
918
        return 1
 
919
 
 
920
    # TODO: Maybe nicer handling of IOError?
 
921
 
 
922
 
 
923
 
 
924
if __name__ == '__main__':
 
925
    sys.exit(main(sys.argv))
 
926
    ##import profile
 
927
    ##profile.run('main(sys.argv)')
 
928