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