getFileStatus has a new parameter (caught by VC++).
[oota-llvm.git] / tools / llvm-ar / llvm-ar.cpp
1 //===-- llvm-ar.cpp - LLVM archive librarian utility ----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Builds up (relatively) standard unix archive files (.a) containing LLVM
11 // bytecode or other files.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Module.h"
16 #include "llvm/Bytecode/Archive.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/Compressor.h"
19 #include "llvm/Support/ManagedStatic.h"
20 #include "llvm/System/Signals.h"
21 #include <iostream>
22 #include <algorithm>
23 #include <iomanip>
24 #include <memory>
25 using namespace llvm;
26
27 // Option for compatibility with ASIX, not used but must allow it to be present.
28 static cl::opt<bool>
29 X32Option ("X32_64", cl::Hidden,
30             cl::desc("Ignored option for compatibility with AIX"));
31
32 // llvm-ar operation code and modifier flags. This must come first.
33 static cl::opt<std::string>
34 Options(cl::Positional, cl::Required, cl::desc("{operation}[modifiers]..."));
35
36 // llvm-ar remaining positional arguments.
37 static cl::list<std::string>
38 RestOfArgs(cl::Positional, cl::OneOrMore,
39     cl::desc("[relpos] [count] <archive-file> [members]..."));
40
41 // MoreHelp - Provide additional help output explaining the operations and
42 // modifiers of llvm-ar. This object instructs the CommandLine library
43 // to print the text of the constructor when the --help option is given.
44 static cl::extrahelp MoreHelp(
45   "\nOPERATIONS:\n"
46   "  d[NsS]       - delete file(s) from the archive\n"
47   "  m[abiSs]     - move file(s) in the archive\n"
48   "  p[kN]        - print file(s) found in the archive\n"
49   "  q[ufsS]      - quick append file(s) to the archive\n"
50   "  r[abfiuzRsS] - replace or insert file(s) into the archive\n"
51   "  t            - display contents of archive\n"
52   "  x[No]        - extract file(s) from the archive\n"
53   "\nMODIFIERS (operation specific):\n"
54   "  [a] - put file(s) after [relpos]\n"
55   "  [b] - put file(s) before [relpos] (same as [i])\n"
56   "  [f] - truncate inserted file names\n"
57   "  [i] - put file(s) before [relpos] (same as [b])\n"
58   "  [k] - always print bytecode files (default is to skip them)\n"
59   "  [N] - use instance [count] of name\n"
60   "  [o] - preserve original dates\n"
61   "  [P] - use full path names when matching\n"
62   "  [R] - recurse through directories when inserting\n"
63   "  [s] - create an archive index (cf. ranlib)\n"
64   "  [S] - do not build a symbol table\n"
65   "  [u] - update only files newer than archive contents\n"
66   "  [z] - compress files before inserting/extracting\n"
67   "\nMODIFIERS (generic):\n"
68   "  [c] - do not warn if the library had to be created\n"
69   "  [v] - be verbose about actions taken\n"
70   "  [V] - be *really* verbose about actions taken\n"
71 );
72
73 // This enumeration delineates the kinds of operations on an archive
74 // that are permitted.
75 enum ArchiveOperation {
76   NoOperation,      ///< An operation hasn't been specified
77   Print,            ///< Print the contents of the archive
78   Delete,           ///< Delete the specified members
79   Move,             ///< Move members to end or as given by {a,b,i} modifiers
80   QuickAppend,      ///< Quickly append to end of archive
81   ReplaceOrInsert,  ///< Replace or Insert members
82   DisplayTable,     ///< Display the table of contents
83   Extract           ///< Extract files back to file system
84 };
85
86 // Modifiers to follow operation to vary behavior
87 bool AddAfter = false;           ///< 'a' modifier
88 bool AddBefore = false;          ///< 'b' modifier
89 bool Create = false;             ///< 'c' modifier
90 bool TruncateNames = false;      ///< 'f' modifier
91 bool InsertBefore = false;       ///< 'i' modifier
92 bool DontSkipBytecode = false;   ///< 'k' modifier
93 bool UseCount = false;           ///< 'N' modifier
94 bool OriginalDates = false;      ///< 'o' modifier
95 bool FullPath = false;           ///< 'P' modifier
96 bool RecurseDirectories = false; ///< 'R' modifier
97 bool SymTable = true;            ///< 's' & 'S' modifiers
98 bool OnlyUpdate = false;         ///< 'u' modifier
99 bool Verbose = false;            ///< 'v' modifier
100 bool ReallyVerbose = false;      ///< 'V' modifier
101 bool Compression = false;        ///< 'z' modifier
102
103 // Relative Positional Argument (for insert/move). This variable holds
104 // the name of the archive member to which the 'a', 'b' or 'i' modifier
105 // refers. Only one of 'a', 'b' or 'i' can be specified so we only need
106 // one variable.
107 std::string RelPos;
108
109 // Select which of multiple entries in the archive with the same name should be
110 // used (specified with -N) for the delete and extract operations.
111 int Count = 1;
112
113 // This variable holds the name of the archive file as given on the
114 // command line.
115 std::string ArchiveName;
116
117 // This variable holds the list of member files to proecess, as given
118 // on the command line.
119 std::vector<std::string> Members;
120
121 // This variable holds the (possibly expanded) list of path objects that
122 // correspond to files we will
123 std::set<sys::Path> Paths;
124
125 // The Archive object to which all the editing operations will be sent.
126 Archive* TheArchive = 0;
127
128 // getRelPos - Extract the member filename from the command line for
129 // the [relpos] argument associated with a, b, and i modifiers
130 void getRelPos() {
131   if(RestOfArgs.size() > 0) {
132     RelPos = RestOfArgs[0];
133     RestOfArgs.erase(RestOfArgs.begin());
134   }
135   else
136     throw "Expected [relpos] for a, b, or i modifier";
137 }
138
139 // getCount - Extract the [count] argument associated with the N modifier
140 // from the command line and check its value.
141 void getCount() {
142   if(RestOfArgs.size() > 0) {
143     Count = atoi(RestOfArgs[0].c_str());
144     RestOfArgs.erase(RestOfArgs.begin());
145   }
146   else
147     throw "Expected [count] value with N modifier";
148
149   // Non-positive counts are not allowed
150   if (Count < 1)
151     throw "Invalid [count] value (not a positive integer)";
152 }
153
154 // getArchive - Get the archive file name from the command line
155 void getArchive() {
156   if(RestOfArgs.size() > 0) {
157     ArchiveName = RestOfArgs[0];
158     RestOfArgs.erase(RestOfArgs.begin());
159   }
160   else
161     throw "An archive name must be specified.";
162 }
163
164 // getMembers - Copy over remaining items in RestOfArgs to our Members vector
165 // This is just for clarity.
166 void getMembers() {
167   if(RestOfArgs.size() > 0)
168     Members = std::vector<std::string>(RestOfArgs);
169 }
170
171 // parseCommandLine - Parse the command line options as presented and return the
172 // operation specified. Process all modifiers and check to make sure that
173 // constraints on modifier/operation pairs have not been violated.
174 ArchiveOperation parseCommandLine() {
175
176   // Keep track of number of operations. We can only specify one
177   // per execution.
178   unsigned NumOperations = 0;
179
180   // Keep track of the number of positional modifiers (a,b,i). Only
181   // one can be specified.
182   unsigned NumPositional = 0;
183
184   // Keep track of which operation was requested
185   ArchiveOperation Operation = NoOperation;
186
187   for(unsigned i=0; i<Options.size(); ++i) {
188     switch(Options[i]) {
189     case 'd': ++NumOperations; Operation = Delete; break;
190     case 'm': ++NumOperations; Operation = Move ; break;
191     case 'p': ++NumOperations; Operation = Print; break;
192     case 'r': ++NumOperations; Operation = ReplaceOrInsert; break;
193     case 't': ++NumOperations; Operation = DisplayTable; break;
194     case 'x': ++NumOperations; Operation = Extract; break;
195     case 'c': Create = true; break;
196     case 'f': TruncateNames = true; break;
197     case 'k': DontSkipBytecode = true; break;
198     case 'l': /* accepted but unused */ break;
199     case 'o': OriginalDates = true; break;
200     case 'P': FullPath = true; break;
201     case 'R': RecurseDirectories = true; break;
202     case 's': SymTable = true; break;
203     case 'S': SymTable = false; break;
204     case 'u': OnlyUpdate = true; break;
205     case 'v': Verbose = true; break;
206     case 'V': Verbose = ReallyVerbose = true; break;
207     case 'z': Compression = true; break;
208     case 'a':
209       getRelPos();
210       AddAfter = true;
211       NumPositional++;
212       break;
213     case 'b':
214       getRelPos();
215       AddBefore = true;
216       NumPositional++;
217       break;
218     case 'i':
219       getRelPos();
220       InsertBefore = true;
221       NumPositional++;
222       break;
223     case 'N':
224       getCount();
225       UseCount = true;
226       break;
227     default:
228       cl::PrintHelpMessage();
229     }
230   }
231
232   // At this point, the next thing on the command line must be
233   // the archive name.
234   getArchive();
235
236   // Everything on the command line at this point is a member.
237   getMembers();
238
239   // Perform various checks on the operation/modifier specification
240   // to make sure we are dealing with a legal request.
241   if (NumOperations == 0)
242     throw "You must specify at least one of the operations";
243   if (NumOperations > 1)
244     throw "Only one operation may be specified";
245   if (NumPositional > 1)
246     throw "You may only specify one of a, b, and i modifiers";
247   if (AddAfter || AddBefore || InsertBefore)
248     if (Operation != Move && Operation != ReplaceOrInsert)
249       throw "The 'a', 'b' and 'i' modifiers can only be specified with "
250             "the 'm' or 'r' operations";
251   if (RecurseDirectories && Operation != ReplaceOrInsert)
252     throw "The 'R' modifiers is only applicabe to the 'r' operation";
253   if (OriginalDates && Operation != Extract)
254     throw "The 'o' modifier is only applicable to the 'x' operation";
255   if (TruncateNames && Operation!=QuickAppend && Operation!=ReplaceOrInsert)
256     throw "The 'f' modifier is only applicable to the 'q' and 'r' operations";
257   if (OnlyUpdate && Operation != ReplaceOrInsert)
258     throw "The 'u' modifier is only applicable to the 'r' operation";
259   if (Compression && Operation!=ReplaceOrInsert && Operation!=Extract)
260     throw "The 'z' modifier is only applicable to the 'r' and 'x' operations";
261   if (Count > 1 && Members.size() > 1)
262     throw "Only one member name may be specified with the 'N' modifier";
263
264   // Return the parsed operation to the caller
265   return Operation;
266 }
267
268 // recurseDirectories - Implements the "R" modifier. This function scans through
269 // the Paths vector (built by buildPaths, below) and replaces any directories it
270 // finds with all the files in that directory (recursively). It uses the
271 // sys::Path::getDirectoryContent method to perform the actual directory scans.
272 bool
273 recurseDirectories(const sys::Path& path, 
274                    std::set<sys::Path>& result, std::string* ErrMsg) {
275   result.clear();
276   if (RecurseDirectories) {
277     std::set<sys::Path> content;
278     if (path.getDirectoryContents(content, ErrMsg))
279       return true;
280
281     for (std::set<sys::Path>::iterator I = content.begin(), E = content.end();
282          I != E; ++I) {
283       // Make sure it exists and is a directory
284       sys::FileStatus Status;
285       if (I->getFileStatus(Status)) {
286         if (Status.isDir) {
287           std::set<sys::Path> moreResults;
288           if (recurseDirectories(*I, moreResults, ErrMsg))
289             return true;
290           result.insert(moreResults.begin(), moreResults.end());
291         } else {
292           result.insert(*I);
293         }
294       }
295     }
296   }
297   return false;
298 }
299
300 // buildPaths - Convert the strings in the Members vector to sys::Path objects
301 // and make sure they are valid and exist exist. This check is only needed for
302 // the operations that add/replace files to the archive ('q' and 'r')
303 bool buildPaths(bool checkExistence, std::string* ErrMsg) {
304   for (unsigned i = 0; i < Members.size(); i++) {
305     sys::Path aPath;
306     if (!aPath.set(Members[i]))
307       throw std::string("File member name invalid: ") + Members[i];
308     if (checkExistence) {
309       if (!aPath.exists())
310         throw std::string("File does not exist: ") + Members[i];
311       sys::FileStatus si;
312       std::string Err;
313       if (aPath.getFileStatus(si, false, &Err))
314         throw Err;
315       if (si.isDir) {
316         std::set<sys::Path> dirpaths;
317         if (recurseDirectories(aPath, dirpaths, ErrMsg))
318           return true;
319         Paths.insert(dirpaths.begin(),dirpaths.end());
320       } else {
321         Paths.insert(aPath);
322       }
323     } else {
324       Paths.insert(aPath);
325     }
326   }
327   return false;
328 }
329
330 // printSymbolTable - print out the archive's symbol table.
331 void printSymbolTable() {
332   std::cout << "\nArchive Symbol Table:\n";
333   const Archive::SymTabType& symtab = TheArchive->getSymbolTable();
334   for (Archive::SymTabType::const_iterator I=symtab.begin(), E=symtab.end();
335        I != E; ++I ) {
336     unsigned offset = TheArchive->getFirstFileOffset() + I->second;
337     std::cout << " " << std::setw(9) << offset << "\t" << I->first <<"\n";
338   }
339 }
340
341 // doPrint - Implements the 'p' operation. This function traverses the archive
342 // looking for members that match the path list. It is careful to uncompress
343 // things that should be and to skip bytecode files unless the 'k' modifier was
344 // given.
345 bool doPrint(std::string* ErrMsg) {
346   if (buildPaths(false, ErrMsg))
347     return true;
348   unsigned countDown = Count;
349   for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
350        I != E; ++I ) {
351     if (Paths.empty() ||
352         (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
353       if (countDown == 1) {
354         const char* data = reinterpret_cast<const char*>(I->getData());
355
356         // Skip things that don't make sense to print
357         if (I->isLLVMSymbolTable() || I->isSVR4SymbolTable() ||
358             I->isBSD4SymbolTable() || (!DontSkipBytecode &&
359              (I->isBytecode() || I->isCompressedBytecode())))
360           continue;
361
362         if (Verbose)
363           std::cout << "Printing " << I->getPath().toString() << "\n";
364
365         if (I->isCompressedBytecode())
366           Compressor::decompressToStream(data+4,I->getSize()-4,std::cout);
367         else if (I->isCompressed()) {
368           Compressor::decompressToStream(data,I->getSize(),std::cout);
369         } else {
370           unsigned len = I->getSize();
371           std::cout.write(data, len);
372         }
373       } else {
374         countDown--;
375       }
376     }
377   }
378   return false;
379 }
380
381 // putMode - utility function for printing out the file mode when the 't'
382 // operation is in verbose mode.
383 void 
384 printMode(unsigned mode) {
385   if (mode & 004)
386     std::cout << "r";
387   else
388     std::cout << "-";
389   if (mode & 002)
390     std::cout << "w";
391   else
392     std::cout << "-";
393   if (mode & 001)
394     std::cout << "x";
395   else
396     std::cout << "-";
397 }
398
399 // doDisplayTable - Implement the 't' operation. This function prints out just
400 // the file names of each of the members. However, if verbose mode is requested
401 // ('v' modifier) then the file type, permission mode, user, group, size, and
402 // modification time are also printed.
403 bool 
404 doDisplayTable(std::string* ErrMsg) {
405   if (buildPaths(false, ErrMsg))
406     return true;
407   for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
408        I != E; ++I ) {
409     if (Paths.empty() ||
410         (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
411       if (Verbose) {
412         // FIXME: Output should be this format:
413         // Zrw-r--r--  500/ 500    525 Nov  8 17:42 2004 Makefile
414         if (I->isBytecode())
415           std::cout << "b";
416         else if (I->isCompressedBytecode())
417           std::cout << "B";
418         else if (I->isCompressed())
419           std::cout << "Z";
420         else
421           std::cout << " ";
422         unsigned mode = I->getMode();
423         printMode((mode >> 6) & 007);
424         printMode((mode >> 3) & 007);
425         printMode(mode & 007);
426         std::cout << " " << std::setw(4) << I->getUser();
427         std::cout << "/" << std::setw(4) << I->getGroup();
428         std::cout << " " << std::setw(8) << I->getSize();
429         std::cout << " " << std::setw(20) <<
430           I->getModTime().toString().substr(4);
431         std::cout << " " << I->getPath().toString() << "\n";
432       } else {
433         std::cout << I->getPath().toString() << "\n";
434       }
435     }
436   }
437   if (ReallyVerbose)
438     printSymbolTable();
439   return false;
440 }
441
442 // doExtract - Implement the 'x' operation. This function extracts files back to
443 // the file system, making sure to uncompress any that were compressed
444 bool 
445 doExtract(std::string* ErrMsg) {
446   if (buildPaths(false, ErrMsg))
447     return true;
448   for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
449        I != E; ++I ) {
450     if (Paths.empty() ||
451         (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
452
453       // Make sure the intervening directories are created
454       if (I->hasPath()) {
455         sys::Path dirs(I->getPath());
456         dirs.eraseComponent();
457         if (dirs.createDirectoryOnDisk(/*create_parents=*/true, ErrMsg)) 
458           return true;
459       }
460
461       // Open up a file stream for writing
462       std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
463                                    std::ios::binary;
464       std::ofstream file(I->getPath().c_str(), io_mode);
465
466       // Get the data and its length
467       const char* data = reinterpret_cast<const char*>(I->getData());
468       unsigned len = I->getSize();
469
470       // Write the data, making sure to uncompress things first
471       if (I->isCompressed()) {
472         Compressor::decompressToStream(data,len,file);
473       } else {
474         file.write(data,len);
475       }
476       file.close();
477
478       // If we're supposed to retain the original modification times, etc. do so
479       // now.
480       if (OriginalDates)
481         I->getPath().setStatusInfoOnDisk(I->getFileStatus());
482     }
483   }
484   return false;
485 }
486
487 // doDelete - Implement the delete operation. This function deletes zero or more
488 // members from the archive. Note that if the count is specified, there should
489 // be no more than one path in the Paths list or else this algorithm breaks.
490 // That check is enforced in parseCommandLine (above).
491 bool 
492 doDelete(std::string* ErrMsg) {
493   if (buildPaths(false, ErrMsg))
494     return true;
495   if (Paths.empty()) 
496     return false;
497   unsigned countDown = Count;
498   for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
499        I != E; ) {
500     if (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end()) {
501       if (countDown == 1) {
502         Archive::iterator J = I;
503         ++I;
504         TheArchive->erase(J);
505       } else
506         countDown--;
507     } else {
508       ++I;
509     }
510   }
511
512   // We're done editting, reconstruct the archive.
513   if (TheArchive->writeToDisk(SymTable,TruncateNames,Compression,ErrMsg))
514     return true;
515   if (ReallyVerbose)
516     printSymbolTable();
517   return false;
518 }
519
520 // doMore - Implement the move operation. This function re-arranges just the
521 // order of the archive members so that when the archive is written the move
522 // of the members is accomplished. Note the use of the RelPos variable to
523 // determine where the items should be moved to.
524 bool 
525 doMove(std::string* ErrMsg) {
526   if (buildPaths(false, ErrMsg)) 
527     return true;
528
529   // By default and convention the place to move members to is the end of the
530   // archive.
531   Archive::iterator moveto_spot = TheArchive->end();
532
533   // However, if the relative positioning modifiers were used, we need to scan
534   // the archive to find the member in question. If we don't find it, its no
535   // crime, we just move to the end.
536   if (AddBefore || InsertBefore || AddAfter) {
537     for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
538          I != E; ++I ) {
539       if (RelPos == I->getPath().toString()) {
540         if (AddAfter) {
541           moveto_spot = I;
542           moveto_spot++;
543         } else {
544           moveto_spot = I;
545         }
546         break;
547       }
548     }
549   }
550
551   // Keep a list of the paths remaining to be moved
552   std::set<sys::Path> remaining(Paths);
553
554   // Scan the archive again, this time looking for the members to move to the
555   // moveto_spot.
556   for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
557        I != E && !remaining.empty(); ++I ) {
558     std::set<sys::Path>::iterator found =
559       std::find(remaining.begin(),remaining.end(),I->getPath());
560     if (found != remaining.end()) {
561       if (I != moveto_spot)
562         TheArchive->splice(moveto_spot,*TheArchive,I);
563       remaining.erase(found);
564     }
565   }
566
567   // We're done editting, reconstruct the archive.
568   if (TheArchive->writeToDisk(SymTable,TruncateNames,Compression,ErrMsg))
569     return true;
570   if (ReallyVerbose)
571     printSymbolTable();
572   return false;
573 }
574
575 // doQuickAppend - Implements the 'q' operation. This function just
576 // indiscriminantly adds the members to the archive and rebuilds it.
577 bool 
578 doQuickAppend(std::string* ErrMsg) {
579   // Get the list of paths to append.
580   if (buildPaths(true, ErrMsg))
581     return true;
582   if (Paths.empty()) 
583     return false;
584
585   // Append them quickly.
586   for (std::set<sys::Path>::iterator PI = Paths.begin(), PE = Paths.end();
587        PI != PE; ++PI) {
588     if (TheArchive->addFileBefore(*PI,TheArchive->end(),ErrMsg))
589       return true;
590   }
591
592   // We're done editting, reconstruct the archive.
593   if (TheArchive->writeToDisk(SymTable,TruncateNames,Compression,ErrMsg))
594     return true;
595   if (ReallyVerbose)
596     printSymbolTable();
597   return false;
598 }
599
600 // doReplaceOrInsert - Implements the 'r' operation. This function will replace
601 // any existing files or insert new ones into the archive.
602 bool 
603 doReplaceOrInsert(std::string* ErrMsg) {
604
605   // Build the list of files to be added/replaced.
606   if (buildPaths(true, ErrMsg))
607     return true;
608   if (Paths.empty()) 
609     return false;
610
611   // Keep track of the paths that remain to be inserted.
612   std::set<sys::Path> remaining(Paths);
613
614   // Default the insertion spot to the end of the archive
615   Archive::iterator insert_spot = TheArchive->end();
616
617   // Iterate over the archive contents
618   for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
619        I != E && !remaining.empty(); ++I ) {
620
621     // Determine if this archive member matches one of the paths we're trying
622     // to replace.
623
624     std::set<sys::Path>::iterator found = remaining.end();
625     for (std::set<sys::Path>::iterator RI = remaining.begin(),
626          RE = remaining.end(); RI != RE; ++RI ) {
627       std::string compare(RI->toString());
628       if (TruncateNames && compare.length() > 15) {
629         const char* nm = compare.c_str();
630         unsigned len = compare.length();
631         size_t slashpos = compare.rfind('/');
632         if (slashpos != std::string::npos) {
633           nm += slashpos + 1;
634           len -= slashpos +1;
635         }
636         if (len > 15)
637           len = 15;
638         compare.assign(nm,len);
639       }
640       if (compare == I->getPath().toString()) {
641         found = RI;
642         break;
643       }
644     }
645
646     if (found != remaining.end()) {
647       sys::FileStatus si;
648       std::string Err;
649       if (found->getFileStatus(si, false, &Err))
650         return true;
651       if (si.isDir) {
652         if (OnlyUpdate) {
653           // Replace the item only if it is newer.
654           if (si.modTime > I->getModTime())
655             if (I->replaceWith(*found, ErrMsg))
656               return true;
657         } else {
658           // Replace the item regardless of time stamp
659           if (I->replaceWith(*found, ErrMsg))
660             return true;
661         }
662       } else {
663         // We purposefully ignore directories.
664       }
665
666       // Remove it from our "to do" list
667       remaining.erase(found);
668     }
669
670     // Determine if this is the place where we should insert
671     if ((AddBefore || InsertBefore) && (RelPos == I->getPath().toString()))
672       insert_spot = I;
673     else if (AddAfter && (RelPos == I->getPath().toString())) {
674       insert_spot = I;
675       insert_spot++;
676     }
677   }
678
679   // If we didn't replace all the members, some will remain and need to be
680   // inserted at the previously computed insert-spot.
681   if (!remaining.empty()) {
682     for (std::set<sys::Path>::iterator PI = remaining.begin(),
683          PE = remaining.end(); PI != PE; ++PI) {
684       if (TheArchive->addFileBefore(*PI,insert_spot, ErrMsg))
685         return true;
686     }
687   }
688
689   // We're done editting, reconstruct the archive.
690   if (TheArchive->writeToDisk(SymTable,TruncateNames,Compression,ErrMsg))
691     return true;
692   if (ReallyVerbose)
693     printSymbolTable();
694   return false;
695 }
696
697 // main - main program for llvm-ar .. see comments in the code
698 int main(int argc, char **argv) {
699   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
700
701   // Have the command line options parsed and handle things
702   // like --help and --version.
703   cl::ParseCommandLineOptions(argc, argv,
704     " LLVM Archiver (llvm-ar)\n\n"
705     "  This program archives bytecode files into single libraries\n"
706   );
707
708   // Print a stack trace if we signal out.
709   sys::PrintStackTraceOnErrorSignal();
710
711   int exitCode = 0;
712
713   // Make sure we don't exit with "unhandled exception".
714   try {
715     // Do our own parsing of the command line because the CommandLine utility
716     // can't handle the grouped positional parameters without a dash.
717     ArchiveOperation Operation = parseCommandLine();
718
719     // Check the path name of the archive
720     sys::Path ArchivePath;
721     if (!ArchivePath.set(ArchiveName))
722       throw std::string("Archive name invalid: ") + ArchiveName;
723
724     // Create or open the archive object.
725     if (!ArchivePath.exists()) {
726       // Produce a warning if we should and we're creating the archive
727       if (!Create)
728         std::cerr << argv[0] << ": creating " << ArchivePath.toString() << "\n";
729       TheArchive = Archive::CreateEmpty(ArchivePath);
730     } else {
731       std::string Error;
732       TheArchive = Archive::OpenAndLoad(ArchivePath, &Error);
733       if (TheArchive == 0) {
734         std::cerr << argv[0] << ": error loading '" << ArchivePath << "': "
735                   << Error << "!\n";
736         return 1;
737       }
738     }
739
740     // Make sure we're not fooling ourselves.
741     assert(TheArchive && "Unable to instantiate the archive");
742
743     // Make sure we clean up the archive even on failure.
744     std::auto_ptr<Archive> AutoArchive(TheArchive);
745
746     // Perform the operation
747     std::string ErrMsg;
748     bool haveError = false;
749     switch (Operation) {
750       case Print:           haveError = doPrint(&ErrMsg); break;
751       case Delete:          haveError = doDelete(&ErrMsg); break;
752       case Move:            haveError = doMove(&ErrMsg); break;
753       case QuickAppend:     haveError = doQuickAppend(&ErrMsg); break;
754       case ReplaceOrInsert: haveError = doReplaceOrInsert(&ErrMsg); break;
755       case DisplayTable:    haveError = doDisplayTable(&ErrMsg); break;
756       case Extract:         haveError = doExtract(&ErrMsg); break;
757       case NoOperation:
758         std::cerr << argv[0] << ": No operation was selected.\n";
759         break;
760     }
761     if (haveError) {
762       std::cerr << argv[0] << ": " << ErrMsg << "\n";
763       return 1;
764     }
765   } catch (const char*msg) {
766     // These errors are usage errors, thrown only by the various checks in the
767     // code above.
768     std::cerr << argv[0] << ": " << msg << "\n\n";
769     cl::PrintHelpMessage();
770     exitCode = 1;
771   } catch (const std::string& msg) {
772     // These errors are thrown by LLVM libraries (e.g. lib System) and represent
773     // a more serious error so we bump the exitCode and don't print the usage.
774     std::cerr << argv[0] << ": " << msg << "\n";
775     exitCode = 2;
776   } catch (...) {
777     // This really shouldn't happen, but just in case ....
778     std::cerr << argv[0] << ": An unexpected unknown exception occurred.\n";
779     exitCode = 3;
780   }
781
782   // Return result code back to operating system.
783   return exitCode;
784 }