From: Michael Vogt Date: Mon, 14 Nov 2005 12:36:18 +0000 (+0000) Subject: * merged daniels wonderful doxygen work X-Git-Tag: 0.7.21~284^2~39 X-Git-Url: https://git.saurik.com/apt.git/commitdiff_plain/3174e150a3c97a471998cfe73a11bd4996da9ab7?hp=-c * merged daniels wonderful doxygen work Patches applied: * dburrows@debian.org--2005/apt--0--base-0 tag of mvo@debian.org--2005/apt--debian-experimental--0--patch-9 * dburrows@debian.org--2005/apt--doxygen--0--base-0 tag of dburrows@debian.org--2005/apt--0--base-0 * dburrows@debian.org--2005/apt--doxygen--0--patch-1 Generate Doxygen output in build/doc/doxygen if Doxygen is installed. * dburrows@debian.org--2005/apt--doxygen--0--patch-2 Partially document the acquire item objects. * dburrows@debian.org--2005/apt--doxygen--0--patch-3 Add an 'acquire' group to collect the stuff related to Acquire. * dburrows@debian.org--2005/apt--doxygen--0--patch-4 Don't pick up emacs autosaves when generating the list of doxygen inputs. * dburrows@debian.org--2005/apt--doxygen--0--patch-5 Don't include redundant scope information in the doxygen output. * dburrows@debian.org--2005/apt--doxygen--0--patch-6 Write more general Acquire documentation. * dburrows@debian.org--2005/apt--doxygen--0--patch-7 I don't know why, but stuff just appeared in my tree. * dburrows@debian.org--2005/apt--doxygen--0--patch-8 Write/edit more Acquire documentation. * dburrows@debian.org--2005/apt--doxygen--0--patch-9 Document pkgAcquire::ItemDesc and pkgAcquire::Queue. * dburrows@debian.org--2005/apt--doxygen--0--patch-10 Document UriIterator (left out documentation of the standard iterator operators). * dburrows@debian.org--2005/apt--doxygen--0--patch-11 Give pkgAcquire::Queue a brief description. * dburrows@debian.org--2005/apt--doxygen--0--patch-12 Add a brief description to pkgAcquire::Item. * dburrows@debian.org--2005/apt--doxygen--0--patch-13 Add a brief description to the DiffInfo class. * dburrows@debian.org--2005/apt--doxygen--0--patch-14 Document pkgAcquire::MethodConfig. * dburrows@debian.org--2005/apt--doxygen--0--patch-15 Document pkgAcquireStatus * dburrows@debian.org--2005/apt--doxygen--0--patch-16 Edit the pkgAcquire::Item documentation to be more in line with how Acquire is documented. * dburrows@debian.org--2005/apt--doxygen--0--patch-17 Document pkgAcqDiffIndex. * dburrows@debian.org--2005/apt--doxygen--0--patch-18 Document the Md5Hash parameter to pkgAcquire::Item::Done. * dburrows@debian.org--2005/apt--doxygen--0--patch-19 Fix a spelling error * dburrows@debian.org--2005/apt--doxygen--0--patch-20 Document pkgAcqIndexDiffs and fix up some previously written documentation. * dburrows@debian.org--2005/apt--doxygen--0--patch-21 Mark the brief descriptions in the acquire item documentation. * dburrows@debian.org--2005/apt--doxygen--0--patch-22 Add documentation about the format of the Message parameter to Done&friends. * dburrows@debian.org--2005/apt--doxygen--0--patch-23 Document pkgAcqIndex. * dburrows@debian.org--2005/apt--doxygen--0--patch-24 Document pkgAcqIndexTrans. * dburrows@debian.org--2005/apt--doxygen--0--patch-25 Autogenerate Doxyfile when Doxyfile.in is modified. * dburrows@debian.org--2005/apt--doxygen--0--patch-26 Check for graphviz in configure. * dburrows@debian.org--2005/apt--doxygen--0--patch-27 Fix the detection of dot. * dburrows@debian.org--2005/apt--doxygen--0--patch-28 If dot is detected, use it to build the documentation. * dburrows@debian.org--2005/apt--doxygen--0--patch-29 Argh, pot update. * dburrows@debian.org--2005/apt--doxygen--0--patch-30 Require graphviz when building the Debian packages. * dburrows@debian.org--2005/apt--doxygen--0--patch-31 Document IndexTarget. * dburrows@debian.org--2005/apt--doxygen--0--patch-32 Consistently capitalize the first word following \param. * dburrows@debian.org--2005/apt--doxygen--0--patch-33 Document pkgAcqMetaSig. * dburrows@debian.org--2005/apt--doxygen--0--patch-34 Be a bit clearer about just what a pkgAcquire::Item is. * dburrows@debian.org--2005/apt--doxygen--0--patch-35 Document pkgAcqMetaIndex. * dburrows@debian.org--2005/apt--doxygen--0--patch-36 Document pkgAcqArchive * dburrows@debian.org--2005/apt--doxygen--0--patch-37 Document pkgAcqFile * dburrows@debian.org--2005/apt--doxygen--0--patch-38 Apply patches from mvo * dburrows@debian.org--2005/apt--doxygen--0--patch-39 Update the Doxyfile template. * dburrows@debian.org--2005/apt--doxygen--0--patch-40 Enable BUILTIN_STL_SUPPORT. * dburrows@debian.org--2005/apt--doxygen--0--patch-41 Whoops: \e, not \i, is used to enable italics. * dburrows@debian.org--2005/apt--doxygen--0--patch-42 Editorial changes and clarifications to the documentation in acquire-item.h * dburrows@debian.org--2005/apt--doxygen--0--patch-43 Clean out the old doxygen output before generating new output. * dburrows@debian.org--2005/apt--doxygen--0--patch-44 Fix setting and using the DOT_PATH doxygen configuration parameter. * dburrows@debian.org--2005/apt--doxygen--0--patch-45 Make the documentation of ��pkgAcquire::MethodConfig::SendConfig somewhat more accurate. * dburrows@debian.org--2005/apt--doxygen--0--patch-46 Partially document pkgAcquire::Worker. * dburrows@debian.org--2005/apt--doxygen--0--patch-47 Finish documenting pkgAcquire::Worker * michael.vogt@ubuntu.com--laptop/apt--doxygen--0--base-0 tag of dburrows@debian.org--2005/apt--doxygen--0--patch-37 * michael.vogt@ubuntu.com--laptop/apt--doxygen--0--patch-1 * some documentation updates * michael.vogt@ubuntu.com--laptop/apt--doxygen--0--patch-2 * apt-pkg/acquire-item.h: reviewed and some modifications * michael.vogt@ubuntu.com--laptop/apt--doxygen--0--patch-3 * minor doc update * michael.vogt@ubuntu.com--laptop/apt--doxygen--0--patch-4 * updated after the input from dburrows * mvo@debian.org--2005/apt--debian-sid--0--base-0 tag of michael.vogt@ubuntu.com--2005/apt--mvo--0--patch-71 * mvo@debian.org--2005/apt--debian-sid--0--patch-1 * merged with apt--mvo--0 * mvo@debian.org--2005/apt--debian-sid--0--patch-2 * merged with apt--mvo * mvo@debian.org--2005/apt--debian-sid--0--patch-3 * updated apt-all.pot * mvo@debian.org--2005/apt--debian-sid--0--patch-4 * merged with apt--mvo * mvo@debian.org--2005/apt--debian-sid--0--patch-5 * merge with apt--mvo--0 * mvo@debian.org--2005/apt--debian-sid--0--patch-6 * merge with apt--mvo * mvo@debian.org--2005/apt--debian-sid--0--patch-7 * applied patch from Petr Vandrovec to fix http download corruption * mvo@debian.org--2005/apt--debian-sid--0--patch-8 * merged with apt--mvo, regenerated the po files * mvo@debian.org--2005/apt--debian-sid--0--patch-9 * merged with apt--mvo --- 3174e150a3c97a471998cfe73a11bd4996da9ab7 diff --combined Makefile index 72cac61b5,72cac61b5..664caca41 --- a/Makefile +++ b/Makefile @@@ -26,7 -26,7 +26,7 @@@ maintainer-clean dist-clean distclean p # The startup target builds the necessary configure scripts. It should # be used after a CVS checkout. --CONVERTED=environment.mak include/config.h include/apti18n.h makefile ++CONVERTED=environment.mak include/config.h include/apti18n.h build/doc/Doxyfile makefile include buildlib/configure.mak $(BUILDDIR)/include/config.h: buildlib/config.h.in $(BUILDDIR)/include/apti18n.h: buildlib/apti18n.h.in diff --combined apt-pkg/acquire-item.cc index 9fb7b57c2,debd1face..7c1626bff --- a/apt-pkg/acquire-item.cc +++ b/apt-pkg/acquire-item.cc @@@ -24,8 -24,6 +24,8 @@@ #include #include #include +#include +#include #include @@@ -33,7 -31,6 +33,7 @@@ #include #include #include +#include #include /*}}}*/ @@@ -134,410 -131,14 +134,410 @@@ void pkgAcquire::Item::Rename(string Fr } /*}}}*/ + +// AcqDiffIndex::AcqDiffIndex - Constructor +// --------------------------------------------------------------------- +/* Get the DiffIndex file first and see if there are patches availabe + * If so, create a pkgAcqIndexDiffs fetcher that will get and apply the + * patches. If anything goes wrong in that process, it will fall back to + * the original packages file + */ +pkgAcqDiffIndex::pkgAcqDiffIndex(pkgAcquire *Owner, + string URI,string URIDesc,string ShortDesc, + string ExpectedMD5) + : Item(Owner), RealURI(URI), ExpectedMD5(ExpectedMD5), Description(URIDesc) +{ + + Debug = _config->FindB("Debug::pkgAcquire::Diffs",false); + + Desc.Description = URIDesc + "/DiffIndex"; + Desc.Owner = this; + Desc.ShortDesc = ShortDesc; + Desc.URI = URI + ".diff/Index"; + + DestFile = _config->FindDir("Dir::State::lists") + "partial/"; + DestFile += URItoFileName(URI) + string(".DiffIndex"); + + if(Debug) + std::clog << "pkgAcqDiffIndex: " << Desc.URI << std::endl; + + // look for the current package file + CurrentPackagesFile = _config->FindDir("Dir::State::lists"); + CurrentPackagesFile += URItoFileName(RealURI); + + if(!FileExists(CurrentPackagesFile) || + !_config->FindB("Acquire::Diffs",true)) { + // we don't have a pkg file or we don't want to queue + if(Debug) + std::clog << "No index file or canceld by user" << std::endl; + Failed("", NULL); + return; + } + + if(Debug) { + std::clog << "pkgAcqIndexDiffs::pkgAcqIndexDiffs(): " + << CurrentPackagesFile << std::endl; + } + + QueueURI(Desc); + +} + +// AcqIndex::Custom600Headers - Insert custom request headers /*{{{*/ +// --------------------------------------------------------------------- +/* The only header we use is the last-modified header. */ +string pkgAcqDiffIndex::Custom600Headers() +{ + string Final = _config->FindDir("Dir::State::lists"); + Final += URItoFileName(RealURI) + string(".IndexDiff"); + + if(Debug) + std::clog << "Custom600Header-IMS: " << Final << std::endl; + + struct stat Buf; + if (stat(Final.c_str(),&Buf) != 0) + return "\nIndex-File: true"; + + return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime); +} + + +bool pkgAcqDiffIndex::ParseDiffIndex(string IndexDiffFile) +{ + if(Debug) + std::clog << "pkgAcqIndexDiffs::ParseIndexDiff() " << IndexDiffFile + << std::endl; + + pkgTagSection Tags; + string ServerSha1; + vector available_patches; + + FileFd Fd(IndexDiffFile,FileFd::ReadOnly); + pkgTagFile TF(&Fd); + if (_error->PendingError() == true) + return false; + + if(TF.Step(Tags) == true) + { + string local_sha1; + bool found = false; + DiffInfo d; + string size; + + string tmp = Tags.FindS("SHA1-Current"); + std::stringstream ss(tmp); + ss >> ServerSha1; + + FileFd fd(CurrentPackagesFile, FileFd::ReadOnly); + SHA1Summation SHA1; + SHA1.AddFD(fd.Fd(), fd.Size()); + local_sha1 = string(SHA1.Result()); + + if(local_sha1 == ServerSha1) { + if(Debug) + std::clog << "Package file is up-to-date" << std::endl; + // set found to true, this will queue a pkgAcqIndexDiffs with + // a empty availabe_patches + found = true; + } else { + if(Debug) + std::clog << "SHA1-Current: " << ServerSha1 << std::endl; + + // check the historie and see what patches we need + string history = Tags.FindS("SHA1-History"); + std::stringstream hist(history); + while(hist >> d.sha1 >> size >> d.file) { + d.size = atoi(size.c_str()); + // read until the first match is found + if(d.sha1 == local_sha1) + found=true; + // from that point on, we probably need all diffs + if(found) { + if(Debug) + std::clog << "Need to get diff: " << d.file << std::endl; + available_patches.push_back(d); + } + } + } + + // no information how to get the patches, bail out + if(!found) { + if(Debug) + std::clog << "Can't find a patch in the index file" << std::endl; + // Failed will queue a big package file + Failed("", NULL); + } else { + // queue the diffs + new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc, + ExpectedMD5, available_patches); + Complete = false; + Status = StatDone; + Dequeue(); + return true; + } + } + + return false; +} + +void pkgAcqDiffIndex::Failed(string Message,pkgAcquire::MethodConfig *Cnf) +{ + if(Debug) + std::clog << "pkgAcqDiffIndex failed: " << Desc.URI << std::endl + << "Falling back to normal index file aquire" << std::endl; + + new pkgAcqIndex(Owner, RealURI, Description, Desc.ShortDesc, + ExpectedMD5); + + Complete = false; + Status = StatDone; + Dequeue(); +} + +void pkgAcqDiffIndex::Done(string Message,unsigned long Size,string Md5Hash, + pkgAcquire::MethodConfig *Cnf) +{ + if(Debug) + std::clog << "pkgAcqDiffIndex::Done(): " << Desc.URI << std::endl; + + Item::Done(Message,Size,Md5Hash,Cnf); + + string FinalFile; + FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(RealURI); + + // sucess in downloading the index + // rename the index + FinalFile += string(".IndexDiff"); + if(Debug) + std::clog << "Renaming: " << DestFile << " -> " << FinalFile + << std::endl; + Rename(DestFile,FinalFile); + chmod(FinalFile.c_str(),0644); + DestFile = FinalFile; + + if(!ParseDiffIndex(DestFile)) + return Failed("", NULL); + + Complete = true; + Status = StatDone; + Dequeue(); + return; +} + + + +// AcqIndexDiffs::AcqIndexDiffs - Constructor +// --------------------------------------------------------------------- +/* The package diff is added to the queue. one object is constructed + * for each diff and the index + */ +pkgAcqIndexDiffs::pkgAcqIndexDiffs(pkgAcquire *Owner, + string URI,string URIDesc,string ShortDesc, + string ExpectedMD5, vector diffs) + : Item(Owner), RealURI(URI), ExpectedMD5(ExpectedMD5), + available_patches(diffs) +{ + + DestFile = _config->FindDir("Dir::State::lists") + "partial/"; + DestFile += URItoFileName(URI); + + Debug = _config->FindB("Debug::pkgAcquire::Diffs",false); + + Desc.Description = URIDesc; + Desc.Owner = this; + Desc.ShortDesc = ShortDesc; + + if(available_patches.size() == 0) { + // we are done (yeah!) + Finish(true); + } else { + // get the next diff + State = StateFetchDiff; + QueueNextDiff(); + } +} + + +void pkgAcqIndexDiffs::Failed(string Message,pkgAcquire::MethodConfig *Cnf) +{ + if(Debug) + std::clog << "pkgAcqIndexDiffs failed: " << Desc.URI << std::endl - << "Falling back to normal index file aquire" << std::endl; ++ << "Falling back to normal index file acquire" << std::endl; + new pkgAcqIndex(Owner, RealURI, Description,Desc.ShortDesc, + ExpectedMD5); + Finish(); +} + + +// helper that cleans the item out of the fetcher queue +void pkgAcqIndexDiffs::Finish(bool allDone) +{ + // we restore the original name, this is required, otherwise + // the file will be cleaned + if(allDone) { + DestFile = _config->FindDir("Dir::State::lists"); + DestFile += URItoFileName(RealURI); + + // do the final md5sum checking + MD5Summation sum; + FileFd Fd(DestFile, FileFd::ReadOnly); + sum.AddFD(Fd.Fd(), Fd.Size()); + Fd.Close(); + string MD5 = (string)sum.Result(); + + if (!ExpectedMD5.empty() && MD5 != ExpectedMD5) + { + Status = StatAuthError; + ErrorText = _("MD5Sum mismatch"); + Rename(DestFile,DestFile + ".FAILED"); + Dequeue(); + return; + } + + // this is for the "real" finish + Complete = true; + Status = StatDone; + Dequeue(); + if(Debug) + std::clog << "\n\nallDone: " << DestFile << "\n" << std::endl; + return; + } + + if(Debug) + std::clog << "Finishing: " << Desc.URI << std::endl; + Complete = false; + Status = StatDone; + Dequeue(); + return; +} + + + +bool pkgAcqIndexDiffs::QueueNextDiff() +{ + + // calc sha1 of the just patched file + string FinalFile = _config->FindDir("Dir::State::lists"); + FinalFile += URItoFileName(RealURI); + + FileFd fd(FinalFile, FileFd::ReadOnly); + SHA1Summation SHA1; + SHA1.AddFD(fd.Fd(), fd.Size()); + string local_sha1 = string(SHA1.Result()); + if(Debug) + std::clog << "QueueNextDiff: " + << FinalFile << " (" << local_sha1 << ")"<::iterator I=available_patches.begin(); + available_patches.size() > 0 && I != available_patches.end() + && (*I).sha1 != local_sha1; + I++) { + available_patches.erase(I); + } + + // error checking and falling back if no patch was found + if(available_patches.size() == 0) { + Failed("", NULL); + return false; + } + + // queue the right diff + Desc.URI = string(RealURI) + ".diff/" + available_patches[0].file + ".gz"; + Desc.Description = available_patches[0].file + string(".pdiff"); + + DestFile = _config->FindDir("Dir::State::lists") + "partial/"; + DestFile += URItoFileName(RealURI + ".diff/" + available_patches[0].file); + + if(Debug) + std::clog << "pkgAcqIndexDiffs::QueueNextDiff(): " << Desc.URI << std::endl; + + QueueURI(Desc); + + return true; +} + + + +void pkgAcqIndexDiffs::Done(string Message,unsigned long Size,string Md5Hash, + pkgAcquire::MethodConfig *Cnf) +{ + if(Debug) + std::clog << "pkgAcqIndexDiffs::Done(): " << Desc.URI << std::endl; + + Item::Done(Message,Size,Md5Hash,Cnf); + + string FinalFile; + FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(RealURI); + + // sucess in downloading a diff, enter ApplyDiff state + if(State == StateFetchDiff) + { + + if(Debug) + std::clog << "Sending to gzip method: " << FinalFile << std::endl; + + string FileName = LookupTag(Message,"Filename"); + State = StateUnzipDiff; + Desc.URI = "gzip:" + FileName; + DestFile += ".decomp"; + QueueURI(Desc); + Mode = "gzip"; + return; + } + + // sucess in downloading a diff, enter ApplyDiff state + if(State == StateUnzipDiff) + { + + // rred excepts the patch as $FinalFile.ed + Rename(DestFile,FinalFile+".ed"); + + if(Debug) + std::clog << "Sending to rred method: " << FinalFile << std::endl; + + State = StateApplyDiff; + Desc.URI = "rred:" + FinalFile; + QueueURI(Desc); + Mode = "rred"; + return; + } + + + // success in download/apply a diff, queue next (if needed) + if(State == StateApplyDiff) + { + // remove the just applied patch + available_patches.erase(available_patches.begin()); + + // move into place + if(Debug) + { + std::clog << "Moving patched file in place: " << std::endl + << DestFile << " -> " << FinalFile << std::endl; + } + Rename(DestFile,FinalFile); + + // see if there is more to download + if(available_patches.size() > 0) { + new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc, + ExpectedMD5, available_patches); + return Finish(); + } else + return Finish(true); + } +} + + // AcqIndex::AcqIndex - Constructor /*{{{*/ // --------------------------------------------------------------------- /* The package file is added to the queue and a second class is instantiated to fetch the revision file */ pkgAcqIndex::pkgAcqIndex(pkgAcquire *Owner, string URI,string URIDesc,string ShortDesc, - string ExpectedMD5, string comprExt) : - Item(Owner), RealURI(URI), ExpectedMD5(ExpectedMD5) + string ExpectedMD5, string comprExt) + : Item(Owner), RealURI(URI), ExpectedMD5(ExpectedMD5) { Decompression = false; Erase = false; @@@ -707,35 -308,6 +707,35 @@@ void pkgAcqIndex::Done(string Message,u Mode = decompProg; } +// AcqIndexTrans::pkgAcqIndexTrans - Constructor /*{{{*/ +// --------------------------------------------------------------------- +/* The Translation file is added to the queue */ +pkgAcqIndexTrans::pkgAcqIndexTrans(pkgAcquire *Owner, + string URI,string URIDesc,string ShortDesc) : + pkgAcqIndex(Owner, URI, URIDesc, ShortDesc, "", "") +{ +} + + /*}}}*/ +// AcqIndexTrans::Failed - Silence failure messages for missing files /*{{{*/ +// --------------------------------------------------------------------- +/* */ +void pkgAcqIndexTrans::Failed(string Message,pkgAcquire::MethodConfig *Cnf) +{ + if (Cnf->LocalOnly == true || + StringToBool(LookupTag(Message,"Transient-Failure"),false) == false) + { + // Ignore this + Status = StatDone; + Complete = false; + Dequeue(); + return; + } + + Item::Failed(Message,Cnf); +} + /*}}}*/ + pkgAcqMetaSig::pkgAcqMetaSig(pkgAcquire *Owner, string URI,string URIDesc,string ShortDesc, string MetaIndexURI, string MetaIndexURIDesc, @@@ -1035,8 -607,8 +1035,8 @@@ void pkgAcqMetaIndex::QueueIndexes(boo } // Queue Packages file - new pkgAcqIndex(Owner, (*Target)->URI, (*Target)->Description, - (*Target)->ShortDesc, ExpectedIndexMD5); + new pkgAcqDiffIndex(Owner, (*Target)->URI, (*Target)->Description, + (*Target)->ShortDesc, ExpectedIndexMD5); } } diff --combined apt-pkg/acquire-item.h index 34fcc2a76,90f80368b..323dff256 --- a/apt-pkg/acquire-item.h +++ b/apt-pkg/acquire-item.h @@@ -9,8 -9,8 +9,8 @@@ the Owner Acquire class. Derived classes will then call QueueURI to register all the URI's they wish to fetch at the initial moment. - Two item classes are provided to provide functionality for downloading - of Index files and downloading of Packages. + Three item classes are provided to provide functionality for + downloading of Index, Translation and Packages files. A Archive class is provided for downloading .deb files. It does Md5 checking and source location as well as a retry algorithm. @@@ -31,131 -31,67 +31,486 @@@ #pragma interface "apt-pkg/acquire-item.h" #endif --// Item to acquire ++/** \addtogroup acquire ++ * @{ ++ * ++ * \file acquire-item.h ++ */ ++ ++/** \brief Represents the process by which a pkgAcquire object should ++ * retrieve a file or a collection of files. ++ * ++ * By convention, Item subclasses should insert themselves into the ++ * acquire queue when they are created by calling QueueURI(), and ++ * remove themselves by calling Dequeue() when either Done() or ++ * Failed() is invoked. Item objects are also responsible for ++ * notifying the download progress indicator (accessible via ++ * #Owner->Log) of their status. ++ * ++ * \see pkgAcquire ++ */ class pkgAcquire::Item { protected: -- // Some private helper methods for registering URIs ++ /** \brief The acquire object with which this item is associated. */ pkgAcquire *Owner; ++ ++ /** \brief Insert this item into its owner's queue. ++ * ++ * \param ItemDesc Metadata about this item (its URI and ++ * description). ++ */ inline void QueueURI(ItemDesc &Item) {Owner->Enqueue(Item);}; ++ ++ /** \brief Remove this item from its owner's queue. */ inline void Dequeue() {Owner->Dequeue(this);}; -- // Safe rename function with timestamp preservation ++ /** \brief Rename a file without modifying its timestamp. ++ * ++ * Many item methods call this as their final action. ++ * ++ * \param From The file to be renamed. ++ * ++ * \param To The new name of #From. If #To exists it will be ++ * overwritten. ++ */ void Rename(string From,string To); public: -- // State of the item -- enum {StatIdle, StatFetching, StatDone, StatError, StatAuthError} Status; ++ /** \brief The current status of this item. */ ++ enum ItemState ++ { ++ /** \brief The item is waiting to be downloaded. */ ++ StatIdle, ++ ++ /** \brief The item is currently being downloaded. */ ++ StatFetching, ++ ++ /** \brief The item has been successfully downloaded. */ ++ StatDone, ++ ++ /** \brief An error was encountered while downloading this ++ * item. ++ */ ++ StatError, ++ ++ /** \brief The item was downloaded but its authenticity could ++ * not be verified. ++ */ ++ StatAuthError ++ } Status; ++ ++ /** \brief Contains a textual description of the error encountered ++ * if #Status is #StatError or #StatAuthError. ++ */ string ErrorText; ++ ++ /** \brief The size of the object to fetch. */ unsigned long FileSize; -- unsigned long PartialSize; ++ ++ /** \brief How much of the object was already fetched. */ ++ unsigned long PartialSize; ++ ++ /** \brief If not \b NULL, contains the name of a subprocess that ++ * is operating on this object (for instance, "gzip" or "gpgv"). ++ */ const char *Mode; ++ ++ /** \brief A client-supplied unique identifier. ++ * ++ * This field is initalized to 0; it is meant to be filled in by ++ * clients that wish to use it to uniquely identify items. ++ * ++ * \todo it's unused in apt itself ++ */ unsigned long ID; ++ ++ /** \brief If \b true, the entire object has been successfully fetched. ++ * ++ * Subclasses should set this to \b true when appropriate. ++ */ bool Complete; ++ ++ /** \brief If \b true, the URI of this object is "local". ++ * ++ * The only effect of this field is to exclude the object from the ++ * download progress indicator's overall statistics. ++ */ bool Local; -- // Number of queues we are inserted into ++ /** \brief The number of fetch queues into which this item has been ++ * inserted. ++ * ++ * There is one queue for each source from which an item could be ++ * downloaded. ++ * ++ * \sa pkgAcquire ++ */ unsigned int QueueCounter; -- // File to write the fetch into ++ /** \brief The name of the file into which the retrieved object ++ * will be written. ++ */ string DestFile; -- // Action members invoked by the worker ++ /** \brief Invoked by the acquire worker when the object couldn't ++ * be fetched. ++ * ++ * This is a branch of the continuation of the fetch process. ++ * ++ * \param Message An RFC822-formatted message from the acquire ++ * method describing what went wrong. Use LookupTag() to parse ++ * it. ++ * ++ * \param Cnf The method via which the worker tried to fetch this object. ++ * ++ * \sa pkgAcqMethod ++ */ virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); ++ ++ /** \brief Invoked by the acquire worker when the object was ++ * fetched successfully. ++ * ++ * Note that the object might \e not have been written to ++ * DestFile; check for the presence of an Alt-Filename entry in ++ * Message to find the file to which it was really written. ++ * ++ * Done is often used to switch from one stage of the processing ++ * to the next (e.g. fetching, unpacking, copying). It is one ++ * branch of the continuation of the fetch process. ++ * ++ * \param Message Data from the acquire method. Use LookupTag() ++ * to parse it. ++ * \param Size The size of the object that was fetched. ++ * \param Md5Hash The MD5Sum of the object that was fetched. ++ * \param Cnf The method via which the object was fetched. ++ * ++ * \sa pkgAcqMethod ++ */ virtual void Done(string Message,unsigned long Size,string Md5Hash, pkgAcquire::MethodConfig *Cnf); ++ ++ /** \brief Invoked when the worker starts to fetch this object. ++ * ++ * \param Message RFC822-formatted data from the worker process. ++ * Use LookupTag() to parse it. ++ * ++ * \param Size The size of the object being fetched. ++ * ++ * \sa pkgAcqMethod ++ */ virtual void Start(string Message,unsigned long Size); ++ ++ /** \brief Custom headers to be sent to the fetch process. ++ * ++ * \return a string containing RFC822-style headers that are to be ++ * inserted into the 600 URI Acquire message sent to the fetch ++ * subprocess. The headers are inserted after a newline-less ++ * line, so they should (if nonempty) have a leading newline and ++ * no trailing newline. ++ */ virtual string Custom600Headers() {return string();}; ++ ++ /** \brief A "descriptive" URI-like string. ++ * ++ * \return a URI that should be used to describe what is being fetched. ++ */ virtual string DescURI() = 0; ++ /** \brief Short item description. ++ * ++ * \return a brief description of the object being fetched. ++ */ virtual string ShortDesc() {return DescURI();} ++ ++ /** \brief Invoked by the worker when the download is completely done. */ virtual void Finished() {}; -- // Inquire functions ++ /** \brief MD5Sum. ++ * ++ * \return the MD5Sum of this object, if applicable; otherwise, an ++ * empty string. ++ */ virtual string MD5Sum() {return string();}; ++ ++ /** \return the acquire process with which this item is associated. */ pkgAcquire *GetOwner() {return Owner;}; ++ ++ /** \return \b true if this object is being fetched from a trusted source. */ virtual bool IsTrusted() {return false;}; -- ++ ++ /** \brief Initialize an item. ++ * ++ * Adds the item to the list of items known to the acquire ++ * process, but does not place it into any fetch queues (you must ++ * manually invoke QueueURI() to do so). ++ * ++ * Initializes all fields of the item other than Owner to 0, ++ * false, or the empty string. ++ * ++ * \param Owner The new owner of this item. ++ */ Item(pkgAcquire *Owner); ++ ++ /** \brief Remove this item from its owner's queue by invoking ++ * pkgAcquire::Remove. ++ */ virtual ~Item(); }; - // item for index diffs - -// Item class for index files -class pkgAcqIndex : public pkgAcquire::Item ++/** \brief Information about an index patch (aka diff). */ +struct DiffInfo { ++ /** The filename of the diff. */ + string file; ++ ++ /** The sha1 hash of the diff. */ + string sha1; ++ ++ /** The size of the diff. */ + unsigned long size; +}; + ++/** \brief An item that is responsible for fetching an index file of ++ * package list diffs and starting the package list's download. ++ * ++ * This item downloads the Index file and parses it, then enqueues ++ * additional downloads of either the individual patches (using ++ * pkgAcqIndexDiffs) or the entire Packages file (using pkgAcqIndex). ++ * ++ * \sa pkgAcqIndexDiffs, pkgAcqIndex ++ */ +class pkgAcqDiffIndex : public pkgAcquire::Item { + protected: ++ /** \brief If \b true, debugging information will be written to std::clog. */ + bool Debug; ++ ++ /** \brief The item that is currently being downloaded. */ + pkgAcquire::ItemDesc Desc; ++ ++ /** \brief The URI of the index file to recreate at our end (either ++ * by downloading it or by applying partial patches). ++ */ + string RealURI; ++ ++ /** \brief The MD5Sum that the real index file should have after ++ * all patches have been applied. ++ */ + string ExpectedMD5; ++ ++ /** \brief The index file which will be patched to generate the new ++ * file. ++ */ + string CurrentPackagesFile; ++ ++ /** \brief A description of the Packages file (stored in ++ * pkgAcquire::ItemDesc::Description). ++ */ + string Description; + + public: + // Specialized action members + virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); + virtual void Done(string Message,unsigned long Size,string Md5Hash, + pkgAcquire::MethodConfig *Cnf); + virtual string DescURI() {return RealURI + "Index";}; + virtual string Custom600Headers(); + - // helpers ++ /** \brief Parse the Index file for a set of Packages diffs. ++ * ++ * Parses the Index file and creates additional download items as ++ * necessary. ++ * ++ * \param IndexDiffFile The name of the Index file. ++ * ++ * \return \b true if the Index file was successfully parsed, \b ++ * false otherwise. ++ */ + bool ParseDiffIndex(string IndexDiffFile); + ++ ++ /** \brief Create a new pkgAcqDiffIndex. ++ * ++ * \param Owner The Acquire object that owns this item. ++ * ++ * \param URI The URI of the list file to download. ++ * ++ * \param URIDesc A long description of the list file to download. ++ * ++ * \param ShortDesc A short description of the list file to download. ++ * ++ * \param ExpectedMD5 The list file's MD5 signature. ++ */ + pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc, - string ShortDesct, string ExpectedMD5); ++ string ShortDesc, string ExpectedMD5); +}; + ++/** \brief An item that is responsible for fetching all the patches ++ * that need to be applied to a given package index file. ++ * ++ * After downloading and applying a single patch, this item will ++ * enqueue a new pkgAcqIndexDiffs to download and apply the remaining ++ * patches. If no patch can be found that applies to an intermediate ++ * file or if one of the patches cannot be downloaded, falls back to ++ * downloading the entire package index file using pkgAcqIndex. ++ * ++ * \sa pkgAcqDiffIndex, pkgAcqIndex ++ */ +class pkgAcqIndexDiffs : public pkgAcquire::Item +{ ++ private: ++ ++ /** \brief Queue up the next diff download. ++ * ++ * Search for the next available diff that applies to the file ++ * that currently exists on disk, and enqueue it by calling ++ * QueueURI(). ++ * ++ * \return \b true if an applicable diff was found, \b false ++ * otherwise. ++ */ ++ bool QueueNextDiff(); ++ ++ /** \brief Handle tasks that must be performed after the item ++ * finishes downloading. ++ * ++ * Dequeues the item and checks the resulting file's md5sum ++ * against ExpectedMD5 after the last patch was applied. ++ * There is no need to check the md5/sha1 after a "normal" ++ * patch because QueueNextDiff() will check the sha1 later. ++ * ++ * \param allDone If \b true, the file was entirely reconstructed, ++ * and its md5sum is verified. ++ */ ++ void Finish(bool allDone=false); ++ protected: ++ ++ /** \brief If \b true, debugging output will be written to ++ * std::clog. ++ */ + bool Debug; ++ ++ /** \brief A description of the item that is currently being ++ * downloaded. ++ */ + pkgAcquire::ItemDesc Desc; ++ ++ /** \brief The URI of the package index file that is being ++ * reconstructed. ++ */ + string RealURI; ++ ++ /** \brief The MD5Sum of the package index file that is being ++ * reconstructed. ++ */ + string ExpectedMD5; + - // this is the SHA-1 sum we expect after the patching ++ /** A description of the file being downloaded. */ + string Description; ++ ++ /** The patches that remain to be downloaded, including the patch ++ * being downloaded right now. This list should be ordered so ++ * that each diff appears before any diff that depends on it. ++ * ++ * \todo These are indexed by sha1sum; why not use some sort of ++ * dictionary instead of relying on ordering and stripping them ++ * off the front? ++ */ + vector available_patches; - enum {StateFetchIndex,StateFetchDiff,StateUnzipDiff,StateApplyDiff} State; ++ /** The current status of this patch. */ ++ enum DiffState ++ { ++ /** \brief The diff is in an unknown state. */ ++ StateFetchUnkown, ++ ++ /** \brief The diff is currently being fetched. */ ++ StateFetchDiff, ++ ++ /** \brief The diff is currently being uncompressed. */ ++ StateUnzipDiff, ++ ++ /** \brief The diff is currently being applied. */ ++ StateApplyDiff ++ } State; + + public: - // Specialized action members ++ /** \brief Called when the patch file failed to be downloaded. ++ * ++ * This method will fall back to downloading the whole index file ++ * outright; its arguments are ignored. ++ */ + virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); ++ + virtual void Done(string Message,unsigned long Size,string Md5Hash, + pkgAcquire::MethodConfig *Cnf); + virtual string DescURI() {return RealURI + "Index";}; + - // various helpers - bool QueueNextDiff(); - bool ApplyDiff(string PatchFile); - void Finish(bool allDone=false); - ++ /** \brief Create an index diff item. ++ * ++ * After filling in its basic fields, this invokes Finish(true) if ++ * #diffs is empty, or QueueNextDiff() otherwise. ++ * ++ * \param Owner The pkgAcquire object that owns this item. ++ * ++ * \param URI The URI of the package index file being ++ * reconstructed. ++ * ++ * \param URIDesc A long description of this item. ++ * ++ * \param ShortDesc A brief description of this item. ++ * ++ * \param ExpectedMD5 The expected md5sum of the completely ++ * reconstructed package index file; the index file will be tested ++ * against this value when it is entirely reconstructed. ++ * ++ * \param diffs The remaining diffs from the index of diffs. They ++ * should be ordered so that each diff appears before any diff ++ * that depends on it. ++ */ + pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc, - string ShortDesct, string ExpectedMD5, ++ string ShortDesc, string ExpectedMD5, + vector diffs=vector()); +}; + - // Item class for index files ++/** \brief An acquire item that is responsible for fetching an index ++ * file (e.g., Packages or Sources). ++ * ++ * \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans ++ * ++ * \todo Why does pkgAcqIndex have protected members? ++ */ +class pkgAcqIndex : public pkgAcquire::Item +{ + protected: - ++ ++ /** \brief If \b true, the index file has been decompressed. */ bool Decompression; ++ ++ /** \brief If \b true, the partially downloaded file will be ++ * removed when the download completes. ++ */ bool Erase; ++ ++ /** \brief The download request that is currently being ++ * processed. ++ */ pkgAcquire::ItemDesc Desc; ++ ++ /** \brief The object that is actually being fetched (minus any ++ * compression-related extensions). ++ */ string RealURI; ++ ++ /** \brief The expected md5sum of the decompressed index file. */ string ExpectedMD5; ++ ++ /** \brief The compression-related file extension that is being ++ * added to the downloaded file (e.g., ".gz" or ".bz2"). ++ */ string CompressionExtension; public: @@@ -167,36 -103,26 +522,120 @@@ virtual string Custom600Headers(); virtual string DescURI() {return RealURI + CompressionExtension;}; ++ /** \brief Create a pkgAcqIndex. ++ * ++ * \param Owner The pkgAcquire object with which this item is ++ * associated. ++ * ++ * \param URI The URI of the index file that is to be downloaded. ++ * ++ * \param URIDesc A "URI-style" description of this index file. ++ * ++ * \param ShortDesc A brief description of this index file. ++ * ++ * \param ExpectedMD5 The expected md5sum of this index file. ++ * ++ * \param compressExt The compression-related extension with which ++ * this index file should be downloaded, or "" to autodetect ++ * (".bz2" is used if bzip2 is installed, ".gz" otherwise). ++ */ pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc, -- string ShortDesct, string ExpectedMD5, string compressExt=""); ++ string ShortDesc, string ExpectedMD5, string compressExt=""); +}; + - // Item class for translated package index files ++/** \brief An acquire item that is responsible for fetching a ++ * translated index file. ++ * ++ * The only difference from pkgAcqIndex is that transient failures ++ * are suppressed: no error occurs if the translated index file is ++ * missing. ++ */ +class pkgAcqIndexTrans : public pkgAcqIndex +{ + public: + + virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); ++ ++ /** \brief Create a pkgAcqIndexTrans. ++ * ++ * \param Owner The pkgAcquire object with which this item is ++ * associated. ++ * ++ * \param URI The URI of the index file that is to be downloaded. ++ * ++ * \param URIDesc A "URI-style" description of this index file. ++ * ++ * \param ShortDesc A brief description of this index file. ++ * ++ * \param ExpectedMD5 The expected md5sum of this index file. ++ * ++ * \param compressExt The compression-related extension with which ++ * this index file should be downloaded, or "" to autodetect ++ * (".bz2" is used if bzip2 is installed, ".gz" otherwise). ++ */ + pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc, - string ShortDesct); ++ string ShortDesc); }; ++/** \brief Information about an index file. */ struct IndexTarget { ++ /** \brief A URI from which the index file can be downloaded. */ string URI; ++ ++ /** \brief A description of the index file. */ string Description; ++ ++ /** \brief A shorter description of the index file. */ string ShortDesc; ++ ++ /** \brief The key by which this index file should be ++ * looked up within the meta signature file. ++ */ string MetaKey; }; --// Item class for index signatures ++/** \brief An acquire item that downloads the detached signature ++ * of a meta-index (Release) file, then queues up the release ++ * file itself. ++ * ++ * \todo Why protected members? ++ * ++ * \sa pkgAcqMetaIndex ++ */ class pkgAcqMetaSig : public pkgAcquire::Item { protected: -- ++ /** \brief The fetch request that is currently being processed. */ pkgAcquire::ItemDesc Desc; -- string RealURI,MetaIndexURI,MetaIndexURIDesc,MetaIndexShortDesc; ++ ++ /** \brief The URI of the signature file. Unlike Desc.URI, this is ++ * never modified; it is used to determine the file that is being ++ * downloaded. ++ */ ++ string RealURI; ++ ++ /** \brief The URI of the meta-index file to be fetched after the signature. */ ++ string MetaIndexURI; ++ ++ /** \brief A "URI-style" description of the meta-index file to be ++ * fetched after the signature. ++ */ ++ string MetaIndexURIDesc; ++ ++ /** \brief A brief description of the meta-index file to be fetched ++ * after the signature. ++ */ ++ string MetaIndexShortDesc; ++ ++ /** \brief A package-system-specific parser for the meta-index file. */ indexRecords* MetaIndexParser; ++ ++ /** \brief The index files which should be looked up in the meta-index ++ * and then downloaded. ++ * ++ * \todo Why a list of pointers instead of a list of structs? ++ */ const vector* IndexTargets; public: @@@ -208,27 -134,27 +647,88 @@@ virtual string Custom600Headers(); virtual string DescURI() {return RealURI; }; ++ /** \brief Create a new pkgAcqMetaSig. */ pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc, string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc, const vector* IndexTargets, indexRecords* MetaIndexParser); }; --// Item class for index signatures ++/** \brief An item that is responsible for downloading the meta-index ++ * file (i.e., Release) itself and verifying its signature. ++ * ++ * Once the download and verification are complete, the downloads of ++ * the individual index files are queued up using pkgAcqDiffIndex. ++ * If the meta-index file had a valid signature, the expected md5sums ++ * of the index files will be the md5sums listed in the meta-index; ++ * otherwise, the expected md5sums will be "" (causing the ++ * authentication of the index files to be bypassed). ++ */ class pkgAcqMetaIndex : public pkgAcquire::Item { protected: -- ++ /** \brief The fetch command that is currently being processed. */ pkgAcquire::ItemDesc Desc; -- string RealURI; // FIXME: is this redundant w/ Desc.URI? ++ ++ /** \brief The URI that is actually being downloaded; never ++ * modified by pkgAcqMetaIndex. ++ */ ++ string RealURI; ++ ++ /** \brief The file in which the signature for this index was stored. ++ * ++ * If empty, the signature and the md5sums of the individual ++ * indices will not be checked. ++ */ string SigFile; ++ ++ /** \brief The index files to download. */ const vector* IndexTargets; ++ ++ /** \brief The parser for the meta-index file. */ indexRecords* MetaIndexParser; ++ ++ /** \brief If \b true, the index's signature is currently being verified. ++ */ bool AuthPass; ++ /** \brief Check that the release file is a release file for the ++ * correct distribution. ++ * ++ * \return \b true if no fatal errors were encountered. ++ */ bool VerifyVendor(); ++ ++ /** \brief Called when a file is finished being retrieved. ++ * ++ * If the file was not downloaded to DestFile, a copy process is ++ * set up to copy it to DestFile; otherwise, Complete is set to \b ++ * true and the file is moved to its final location. ++ * ++ * \param Message The message block received from the fetch ++ * subprocess. ++ */ void RetrievalDone(string Message); ++ ++ /** \brief Called when authentication succeeded. ++ * ++ * Sanity-checks the authenticated file, queues up the individual ++ * index files for download, and saves the signature in the lists ++ * directory next to the authenticated list file. ++ * ++ * \param Message The message block received from the fetch ++ * subprocess. ++ */ void AuthDone(string Message); ++ ++ /** \brief Starts downloading the individual index files. ++ * ++ * \param verify If \b true, only indices whose expected md5sum ++ * can be determined from the meta-index will be downloaded, and ++ * the md5sums of indices will be checked (reporting ++ * #StatAuthError if there is a mismatch). If verify is \b false, ++ * no md5sum checking will be performed. ++ */ void QueueIndexes(bool verify); public: @@@ -240,6 -166,6 +740,7 @@@ virtual string Custom600Headers(); virtual string DescURI() {return RealURI; }; ++ /** \brief Create a new pkgAcqMetaIndex. */ pkgAcqMetaIndex(pkgAcquire *Owner, string URI,string URIDesc, string ShortDesc, string SigFile, @@@ -247,28 -173,28 +748,58 @@@ indexRecords* MetaIndexParser); }; --// Item class for archive files ++/** \brief An item that is responsible for fetching a package file. ++ * ++ * If the package file already exists in the cache, nothing will be ++ * done. ++ */ class pkgAcqArchive : public pkgAcquire::Item { protected: -- -- // State information for the retry mechanism ++ /** \brief The package version being fetched. */ pkgCache::VerIterator Version; ++ ++ /** \brief The fetch command that is currently being processed. */ pkgAcquire::ItemDesc Desc; ++ ++ /** \brief The list of sources from which to pick archives to ++ * download this package from. ++ */ pkgSourceList *Sources; ++ ++ /** \brief A package records object, used to look up the file ++ * corresponding to each version of the package. ++ */ pkgRecords *Recs; ++ ++ /** \brief The md5sum of this package. */ string MD5; ++ ++ /** \brief A location in which the actual filename of the package ++ * should be stored. ++ */ string &StoreFilename; ++ ++ /** \brief The next file for this version to try to download. */ pkgCache::VerFileIterator Vf; ++ ++ /** \brief How many (more) times to try to find a new source from ++ * which to download this package version if it fails. ++ * ++ * Set from Acquire::Retries. ++ */ unsigned int Retries; ++ ++ /** \brief \b true if this version file is being downloaded from a ++ * trusted source. ++ */ bool Trusted; -- // Queue the next available file for download. ++ /** \brief Queue up the next available file for this version. */ bool QueueNext(); public: -- // Specialized action members virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); virtual void Done(string Message,unsigned long Size,string Md5Hash, pkgAcquire::MethodConfig *Cnf); @@@ -276,18 -202,18 +807,49 @@@ virtual string DescURI() {return Desc.URI;}; virtual string ShortDesc() {return Desc.ShortDesc;}; virtual void Finished(); ++ virtual bool IsTrusted(); ++ /** \brief Create a new pkgAcqArchive. ++ * ++ * \param Owner The pkgAcquire object with which this item is ++ * associated. ++ * ++ * \param Sources The sources from which to download version ++ * files. ++ * ++ * \param Recs A package records object, used to look up the file ++ * corresponding to each version of the package. ++ * ++ * \param Version The package version to download. ++ * ++ * \param StoreFilename A location in which the actual filename of ++ * the package should be stored. It will be set to a guessed ++ * basename in the constructor, and filled in with a fully ++ * qualified filename once the download finishes. ++ */ pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources, pkgRecords *Recs,pkgCache::VerIterator const &Version, string &StoreFilename); }; --// Fetch a generic file to the current directory ++/** \brief Retrieve an arbitrary file to the current directory. ++ * ++ * The file is retrieved even if it is accessed via a URL type that ++ * normally is a NOP, such as "file". If the download fails, the ++ * partial file is renamed to get a ".FAILED" extension. ++ */ class pkgAcqFile : public pkgAcquire::Item { ++ /** \brief The currently active download process. */ pkgAcquire::ItemDesc Desc; ++ ++ /** \brief The md5sum of the file to download, if it is known. */ string Md5Hash; ++ ++ /** \brief How many times to retry the download, set from ++ * Acquire::Retries. ++ */ unsigned int Retries; public: @@@ -298,9 -224,9 +860,29 @@@ pkgAcquire::MethodConfig *Cnf); virtual string MD5Sum() {return Md5Hash;}; virtual string DescURI() {return Desc.URI;}; -- ++ ++ /** \brief Create a new pkgAcqFile object. ++ * ++ * \param Owner The pkgAcquire object with which this object is ++ * associated. ++ * ++ * \param URI The URI to download. ++ * ++ * \param MD5 The md5sum of the file to download, if it is known; ++ * otherwise "". ++ * ++ * \param Size The size of the file to download, if it is known; ++ * otherwise 0. ++ * ++ * \param Desc A description of the file being downloaded. ++ * ++ * \param ShortDesc A brief description of the file being ++ * downloaded. ++ */ pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size, string Desc,string ShortDesc); }; ++/** @} */ ++ #endif diff --combined apt-pkg/acquire-method.h index f46209d12,f46209d12..4f08a43ae --- a/apt-pkg/acquire-method.h +++ b/apt-pkg/acquire-method.h @@@ -10,6 -10,6 +10,13 @@@ ##################################################################### */ /*}}}*/ ++ ++/** \addtogroup acquire ++ * @{ ++ * ++ * \file acquire-method.h ++ */ ++ #ifndef PKGLIB_ACQUIRE_METHOD_H #define PKGLIB_ACQUIRE_METHOD_H @@@ -86,4 -86,4 +93,6 @@@ class pkgAcqMetho virtual ~pkgAcqMethod() {}; }; ++/** @} */ ++ #endif diff --combined apt-pkg/acquire-worker.h index 6e1952202,6e1952202..1f6bcc05f --- a/apt-pkg/acquire-worker.h +++ b/apt-pkg/acquire-worker.h @@@ -9,6 -9,6 +9,13 @@@ ##################################################################### */ /*}}}*/ ++ ++/** \addtogroup acquire ++ * @{ ++ * ++ * \file acquire-worker.h ++ */ ++ #ifndef PKGLIB_ACQUIRE_WORKER_H #define PKGLIB_ACQUIRE_WORKER_H @@@ -18,7 -18,7 +25,25 @@@ #pragma interface "apt-pkg/acquire-worker.h" #endif --// Interfacing to the method process ++/** \brief A fetch subprocess. ++ * ++ * A worker process is responsible for one stage of the fetch. This ++ * class encapsulates the communications protocol between the master ++ * process and the worker, from the master end. ++ * ++ * Each worker is intrinsically placed on two linked lists. The ++ * Queue list (maintained in the #NextQueue variable) is maintained ++ * by the pkgAcquire::Queue class; it represents the set of workers ++ * assigned to a particular queue. The Acquire list (maintained in ++ * the #NextAcquire variable) is maintained by the pkgAcquire class; ++ * it represents the set of active workers for a particular ++ * pkgAcquire object. ++ * ++ * \todo Like everything else in the Acquire system, this has way too ++ * many protected items. ++ * ++ * \sa pkgAcqMethod, pkgAcquire::Item, pkgAcquire ++ */ class pkgAcquire::Worker { friend class pkgAcquire; @@@ -26,64 -26,64 +51,274 @@@ protected: friend class Queue; -- /* Linked list starting at a Queue and a linked list starting -- at Acquire */ ++ /** \brief The next link on the Queue list. ++ * ++ * \todo This is always NULL; is it just for future use? ++ */ Worker *NextQueue; ++ ++ /** \brief The next link on the Acquire list. */ Worker *NextAcquire; -- // The access association ++ /** \brief The Queue with which this worker is associated. */ Queue *OwnerQ; ++ ++ /** \brief The download progress indicator to which progress ++ * messages should be sent. ++ */ pkgAcquireStatus *Log; ++ ++ /** \brief The configuration of this method. On startup, the ++ * target of this pointer is filled in with basic data about the ++ * method, as reported by the worker. ++ */ MethodConfig *Config; ++ ++ /** \brief The access method to be used by this worker. ++ * ++ * \todo Doesn't this duplicate Config->Access? ++ */ string Access; -- // This is the subprocess IPC setup ++ /** \brief The PID of the subprocess. */ pid_t Process; ++ ++ /** \brief A file descriptor connected to the standard output of ++ * the subprocess. ++ * ++ * Used to read messages and data from the subprocess. ++ */ int InFd; ++ ++ /** \brief A file descriptor connected to the standard input of the ++ * subprocess. ++ * ++ * Used to send commands and configuration data to the subprocess. ++ */ int OutFd; ++ ++ /** \brief Set to \b true if the worker is in a state in which it ++ * might generate data or command responses. ++ * ++ * \todo Is this right? It's a guess. ++ */ bool InReady; ++ ++ /** \brief Set to \b true if the worker is in a state in which it ++ * is legal to send commands to it. ++ * ++ * \todo Is this right? ++ */ bool OutReady; -- // Various internal things ++ /** If \b true, debugging output will be sent to std::clog. */ bool Debug; ++ ++ /** \brief The raw text values of messages received from the ++ * worker, in sequence. ++ */ vector MessageQueue; ++ ++ /** \brief Buffers pending writes to the subprocess. ++ * ++ * \todo Wouldn't a std::dequeue be more appropriate? ++ */ string OutQueue; -- // Private constructor helper ++ /** \brief Common code for the constructor. ++ * ++ * Initializes NextQueue and NextAcquire to NULL; Process, InFd, ++ * and OutFd to -1, OutReady and InReady to \b false, and Debug ++ * from _config. ++ */ void Construct(); -- // Message handling things ++ /** \brief Retrieve any available messages from the subprocess. ++ * ++ * The messages are retrieved as in ::ReadMessages(), and ++ * MessageFailure() is invoked if an error occurs; in particular, ++ * if the pipe to the subprocess dies unexpectedly while a message ++ * is being read. ++ * ++ * \return \b true if the messages were successfully read, \b ++ * false otherwise. ++ */ bool ReadMessages(); ++ ++ /** \brief Parse and dispatch pending messages. ++ * ++ * This dispatches the message in a manner appropriate for its ++ * type. ++ * ++ * \todo Several message types lack separate handlers. ++ * ++ * \sa Capabilities(), SendConfiguration(), MediaChange() ++ */ bool RunMessages(); ++ ++ /** \brief Read and dispatch any pending messages from the ++ * subprocess. ++ * ++ * \return \b false if the subprocess died unexpectedly while a ++ * message was being transmitted. ++ */ bool InFdReady(); ++ ++ /** \brief Send any pending commands to the subprocess. ++ * ++ * This method will fail if there is no pending output. ++ * ++ * \return \b true if all commands were succeeded, \b false if an ++ * error occurred (in which case MethodFailure() will be invoked). ++ */ bool OutFdReady(); -- // The message handlers ++ /** \brief Handle a 100 Capabilities response from the subprocess. ++ * ++ * \param Message the raw text of the message from the subprocess. ++ * ++ * The message will be parsed and its contents used to fill ++ * #Config. If #Config is NULL, this routine is a NOP. ++ * ++ * \return \b true. ++ */ bool Capabilities(string Message); ++ ++ /** \brief Send a 601 Configuration message (containing the APT ++ * configuration) to the subprocess. ++ * ++ * The APT configuration will be send to the subprocess in a ++ * message of the following form: ++ * ++ * 
++    *  601 Configuration
++    *  Config-Item: Fully-Qualified-Item=Val
++    *  Config-Item: Fully-Qualified-Item=Val
++    *  ...
++    *
++ * ++ * \return \b true if the command was successfully sent, \b false ++ * otherwise. ++ */ bool SendConfiguration(); ++ ++ /** \brief Handle a 403 Media Change message. ++ * ++ * \param Message the raw text of the message; the Media field ++ * indicates what type of media should be changed, and the Drive ++ * field indicates where the media is located. ++ * ++ * Invokes pkgAcquireStatus::MediaChange(Media, Drive) to ask the ++ * user to swap disks; informs the subprocess of the result (via ++ * 603 Media Changed, with the Failed field set to \b true if the ++ * user cancelled the media change). ++ */ bool MediaChange(string Message); ++ /** \brief Invoked when the worked process dies unexpectedly. ++ * ++ * Waits for the subprocess to terminate and generates an error if ++ * it terminated abnormally, then closes and blanks out all file ++ * descriptors. Discards all pending messages from the ++ * subprocess. ++ * ++ * \return \b false. ++ */ bool MethodFailure(); ++ ++ /** \brief Invoked when a fetch job is completed, either ++ * successfully or unsuccessfully. ++ * ++ * Resets the status information for the worker process. ++ */ void ItemDone(); public: -- // The curent method state ++ /** \brief The queue entry that is currently being downloaded. */ pkgAcquire::Queue::QItem *CurrentItem; ++ ++ /** \brief The most recent status string received from the ++ * subprocess. ++ */ string Status; ++ ++ /** \brief How many bytes of the file have been downloaded. Zero ++ * if the current progress of the file cannot be determined. ++ */ unsigned long CurrentSize; ++ ++ /** \brief The total number of bytes to be downloaded. Zero if the ++ * total size of the final is unknown. ++ */ unsigned long TotalSize; ++ ++ /** \brief How much of the file was already downloaded prior to ++ * starting this worker. ++ */ unsigned long ResumePoint; -- // Load the method and do the startup ++ /** \brief Tell the subprocess to download the given item. ++ * ++ * \param Item the item to queue up. ++ * \return \b true if the item was successfully enqueued. ++ * ++ * Queues up a 600 URI Acquire message for the given item to be ++ * sent at the next possible moment. Does \e not flush the output ++ * queue. ++ */ bool QueueItem(pkgAcquire::Queue::QItem *Item); ++ ++ /** \brief Start up the worker and fill in #Config. ++ * ++ * Reads the first message from the worker, which is assumed to be ++ * a 100 Capabilities message. ++ * ++ * \return \b true if all operations completed successfully. ++ */ bool Start(); ++ ++ /** \brief Update the worker statistics (CurrentSize, TotalSize, ++ * etc). ++ */ void Pulse(); ++ ++ /** \return The fetch method configuration. */ inline const MethodConfig *GetConf() const {return Config;}; -- ++ ++ /** \brief Create a new Worker to download files. ++ * ++ * \param OwnerQ The queue into which this worker should be ++ * placed. ++ * ++ * \param Config A location in which to store information about ++ * the fetch method. ++ * ++ * \param Log The download progress indicator that should be used ++ * to report the progress of this worker. ++ */ Worker(Queue *OwnerQ,MethodConfig *Config,pkgAcquireStatus *Log); ++ ++ /** \brief Create a new Worker that should just retrieve ++ * information about the fetch method. ++ * ++ * Nothing in particular forces you to refrain from actually ++ * downloading stuff, but the various status callbacks won't be ++ * invoked. ++ * ++ * \param Config A location in which to store information about ++ * the fetch method. ++ */ Worker(MethodConfig *Config); ++ ++ /** \brief Clean up this worker. ++ * ++ * Closes the file descriptors; if MethodConfig::NeedsCleanup is ++ * \b false, also rudely interrupts the worker with a SIGINT. ++ */ ~Worker(); }; ++/** @} */ ++ #endif diff --combined apt-pkg/acquire.h index 27bb3d363,27bb3d363..64dafdc9d --- a/apt-pkg/acquire.h +++ b/apt-pkg/acquire.h @@@ -29,6 -29,6 +29,40 @@@ ##################################################################### */ /*}}}*/ ++ ++/** \defgroup acquire Acquire system ++ * ++ * \brief The Acquire system is responsible for retrieving files from ++ * local or remote URIs and postprocessing them (for instance, ++ * verifying their authenticity). The core class in this system is ++ * pkgAcquire, which is responsible for managing the download queues ++ * during the download. There is at least one download queue for ++ * each supported protocol; protocols such as http may provide one ++ * queue per host. ++ * ++ * Each file to download is represented by a subclass of ++ * pkgAcquire::Item. The files add themselves to the download ++ * queue(s) by providing their URI information to ++ * pkgAcquire::Item::QueueURI, which calls pkgAcquire::Enqueue. ++ * ++ * Once the system is set up, the Run method will spawn subprocesses ++ * to handle the enqueued URIs; the scheduler will then take items ++ * from the queues and feed them into the handlers until the queues ++ * are empty. ++ * ++ * \todo Acquire supports inserting an object into several queues at ++ * once, but it is not clear what its behavior in this case is, and ++ * no subclass of pkgAcquire::Item seems to actually use this ++ * capability. ++ */ ++ ++/** \addtogroup acquire ++ * ++ * @{ ++ * ++ * \file acquire.h ++ */ ++ #ifndef PKGLIB_ACQUIRE_H #define PKGLIB_ACQUIRE_H @@@ -46,6 -46,6 +80,15 @@@ using std::string #include class pkgAcquireStatus; ++ ++/** \brief The core download scheduler. ++ * ++ * This class represents an ongoing download. It manages the lists ++ * of active and pending downloads and handles setting up and tearing ++ * down download-related structures. ++ * ++ * \todo Why all the protected data items and methods? ++ */ class pkgAcquire { public: @@@ -60,97 -60,97 +103,299 @@@ typedef vector::iterator ItemIterator; typedef vector::const_iterator ItemCIterator; -- ++ protected: -- // List of items to fetch ++ /** \brief A list of items to download. ++ * ++ * This is built monotonically as items are created and only ++ * emptied when the download shuts down. ++ */ vector Items; -- // List of active queues and fetched method configuration parameters ++ /** \brief The head of the list of active queues. ++ * ++ * \todo why a hand-managed list of queues instead of std::list or ++ * std::set? ++ */ Queue *Queues; ++ ++ /** \brief The head of the list of active workers. ++ * ++ * \todo why a hand-managed list of workers instead of std::list ++ * or std::set? ++ */ Worker *Workers; ++ ++ /** \brief The head of the list of acquire method configurations. ++ * ++ * Each protocol (http, ftp, gzip, etc) via which files can be ++ * fetched can have a representation in this list. The ++ * configuration data is filled in by parsing the 100 Capabilities ++ * string output by a method on startup (see ++ * pkgAcqMethod::pkgAcqMethod and pkgAcquire::GetConfig). ++ * ++ * \todo why a hand-managed config dictionary instead of std::map? ++ */ MethodConfig *Configs; ++ ++ /** \brief The progress indicator for this download. */ pkgAcquireStatus *Log; ++ ++ /** \brief The total size of the files which are to be fetched. ++ * ++ * This is not necessarily the total number of bytes to download ++ * when, e.g., download resumption and list updates via patches ++ * are taken into account. ++ */ unsigned long ToFetch; -- // Configurable parameters for the schedular -- enum {QueueHost,QueueAccess} QueueMode; ++ // Configurable parameters for the scheduler ++ ++ /** \brief Represents the queuing strategy for remote URIs. */ ++ enum QueueStrategy { ++ /** \brief Generate one queue for each protocol/host combination; downloads from ++ * multiple hosts can proceed in parallel. ++ */ ++ QueueHost, ++ /** \brief Generate a single queue for each protocol; serialize ++ * downloads from multiple hosts. ++ */ ++ QueueAccess} QueueMode; ++ ++ /** \brief If \b true, debugging information will be dumped to std::clog. */ bool Debug; ++ /** \brief If \b true, a download is currently in progress. */ bool Running; -- ++ ++ /** \brief Add the given item to the list of items. */ void Add(Item *Item); ++ ++ /** \brief Remove the given item from the list of items. */ void Remove(Item *Item); ++ ++ /** \brief Add the given worker to the list of workers. */ void Add(Worker *Work); ++ ++ /** \brief Remove the given worker from the list of workers. */ void Remove(Worker *Work); ++ /** \brief Insert the given fetch request into the appropriate queue. ++ * ++ * \param Item The URI to download and the item to download it ++ * for. Copied by value into the queue; no reference to Item is ++ * retained. ++ */ void Enqueue(ItemDesc &Item); ++ ++ /** \brief Remove all fetch requests for this item from all queues. */ void Dequeue(Item *Item); ++ ++ /** \brief Determine the fetch method and queue of a URI. ++ * ++ * \param URI The URI to fetch. ++ * ++ * \param[out] Config A location in which to place the method via ++ * which the URI is to be fetched. ++ * ++ * \return the string-name of the queue in which a fetch request ++ * for the given URI should be placed. ++ */ string QueueName(string URI,MethodConfig const *&Config); -- // FDSET managers for derived classes ++ /** \brief Build up the set of file descriptors upon which select() should ++ * block. ++ * ++ * The default implementation inserts the file descriptors ++ * corresponding to active downloads. ++ * ++ * \param[out] Fd The largest file descriptor in the generated sets. ++ * ++ * \param[out] RSet The set of file descriptors that should be ++ * watched for input. ++ * ++ * \param[out] WSet The set of file descriptors that should be ++ * watched for output. ++ */ virtual void SetFds(int &Fd,fd_set *RSet,fd_set *WSet); ++ ++ /** Handle input from and output to file descriptors which select() ++ * has determined are ready. The default implementation ++ * dispatches to all active downloads. ++ * ++ * \param RSet The set of file descriptors that are ready for ++ * input. ++ * ++ * \param WSet The set of file descriptors that are ready for ++ * output. ++ */ virtual void RunFds(fd_set *RSet,fd_set *WSet); -- // A queue calls this when it dequeues an item ++ /** \brief Check for idle queues with ready-to-fetch items. ++ * ++ * Called by pkgAcquire::Queue::Done each time an item is dequeued ++ * but remains on some queues; i.e., another queue should start ++ * fetching it. ++ */ void Bump(); public: ++ /** \brief Retrieve information about a fetch method by name. ++ * ++ * \param Access The name of the method to look up. ++ * ++ * \return the method whose name is Access, or \b NULL if no such method exists. ++ */ MethodConfig *GetConfig(string Access); -- enum RunResult {Continue,Failed,Cancelled}; ++ /** \brief Provides information on how a download terminated. */ ++ enum RunResult { ++ /** \brief All files were fetched successfully. */ ++ Continue, ++ ++ /** \brief Some files failed to download. */ ++ Failed, ++ ++ /** \brief The download was cancelled by the user (i.e., #Log's ++ * pkgAcquireStatus::Pulse() method returned \b false). ++ */ ++ Cancelled}; -- RunResult Run(int PulseIntervall=500000); ++ /** \brief Download all the items that have been Add()ed to this ++ * download process. ++ * ++ * This method will block until the download completes, invoking ++ * methods on #Log to report on the progress of the download. ++ * ++ * \param PulseInterval The method pkgAcquireStatus::Pulse will be ++ * invoked on #Log at intervals of PulseInterval milliseconds. ++ * ++ * \return the result of the download. ++ */ ++ RunResult Run(int PulseInterval=500000); ++ ++ /** \brief Remove all items from this download process, terminate ++ * all download workers, and empty all queues. ++ */ void Shutdown(); -- // Simple iteration mechanism ++ /** \brief Get the first #Worker object. ++ * ++ * \return the first active worker in this download process. ++ */ inline Worker *WorkersBegin() {return Workers;}; ++ ++ /** \brief Advance to the next #Worker object. ++ * ++ * \return the worker immediately following I, or \b NULL if none ++ * exists. ++ */ Worker *WorkerStep(Worker *I); ++ ++ /** \brief Get the head of the list of items. */ inline ItemIterator ItemsBegin() {return Items.begin();}; ++ ++ /** \brief Get the end iterator of the list of items. */ inline ItemIterator ItemsEnd() {return Items.end();}; // Iterate over queued Item URIs class UriIterator; ++ /** \brief Get the head of the list of enqueued item URIs. ++ * ++ * This iterator will step over every element of every active ++ * queue. ++ */ UriIterator UriBegin(); ++ /** \brief Get the end iterator of the list of enqueued item URIs. */ UriIterator UriEnd(); -- // Cleans out the download dir ++ /** Deletes each entry in the given directory that is not being ++ * downloaded by this object. For instance, when downloading new ++ * list files, calling Clean() will delete the old ones. ++ * ++ * \param Dir The directory to be cleaned out. ++ * ++ * \return \b true if the directory exists and is readable. ++ */ bool Clean(string Dir); -- // Returns the size of the total download set ++ /** \return the total size in bytes of all the items included in ++ * this download. ++ */ double TotalNeeded(); ++ ++ /** \return the size in bytes of all non-local items included in ++ * this download. ++ */ double FetchNeeded(); ++ ++ /** \return the amount of data to be fetched that is already ++ * present on the filesystem. ++ */ double PartialPresent(); ++ /** \brief Construct a new pkgAcquire. ++ * ++ * \param Log The progress indicator associated with this ++ * download, or \b NULL for none. This object is not owned by the ++ * download process and will not be deleted when the pkgAcquire ++ * object is destroyed. Naturally, it should live for at least as ++ * long as the pkgAcquire object does. ++ */ pkgAcquire(pkgAcquireStatus *Log = 0); ++ ++ /** \brief Destroy this pkgAcquire object. ++ * ++ * Destroys all queue, method, and item objects associated with ++ * this download. ++ */ virtual ~pkgAcquire(); }; --// Description of an Item+URI ++/** \brief Represents a single download source from which an item ++ * should be downloaded. ++ * ++ * An item may have several assocated ItemDescs over its lifetime. ++ */ struct pkgAcquire::ItemDesc { ++ /** \brief The URI from which to download this item. */ string URI; ++ /** brief A description of this item. */ string Description; ++ /** brief A shorter description of this item. */ string ShortDesc; ++ /** brief The underlying item which is to be downloaded. */ Item *Owner; }; --// List of possible items queued for download. ++/** \brief A single download queue in a pkgAcquire object. ++ * ++ * \todo Why so many protected values? ++ */ class pkgAcquire::Queue { friend class pkgAcquire; friend class pkgAcquire::UriIterator; friend class pkgAcquire::Worker; ++ ++ /** \brief The next queue in the pkgAcquire object's list of queues. */ Queue *Next; protected: -- // Queued item ++ /** \brief A single item placed in this queue. */ struct QItem : pkgAcquire::ItemDesc { -- QItem *Next; ++ /** \brief The next item in the queue. */ ++ QItem *Next; ++ /** \brief The worker associated with this item, if any. */ pkgAcquire::Worker *Worker; -- ++ ++ /** \brief Assign the ItemDesc portion of this QItem from ++ * another ItemDesc ++ */ void operator =(pkgAcquire::ItemDesc const &I) { URI = I.URI; @@@ -160,45 -160,45 +405,141 @@@ }; }; -- // Name of the queue ++ /** \brief The name of this queue. */ string Name; -- // Items queued into this queue ++ /** \brief The head of the list of items contained in this queue. ++ * ++ * \todo why a by-hand list instead of an STL structure? ++ */ QItem *Items; ++ ++ /** \brief The head of the list of workers associated with this queue. ++ * ++ * \todo This is plural because support exists in Queue for ++ * multiple workers. However, it does not appear that there is ++ * any way to actually associate more than one worker with a ++ * queue. ++ * ++ * \todo Why not just use a std::set? ++ */ pkgAcquire::Worker *Workers; ++ ++ /** \brief the download scheduler with which this queue is associated. */ pkgAcquire *Owner; ++ ++ /** \brief The number of entries in this queue that are currently ++ * being downloaded. ++ */ signed long PipeDepth; ++ ++ /** \brief The maximum number of entries that this queue will ++ * attempt to download at once. ++ */ unsigned long MaxPipeDepth; public: -- // Put an item into this queue ++ /** \brief Insert the given fetch request into this queue. */ void Enqueue(ItemDesc &Item); ++ ++ /** \brief Remove all fetch requests for the given item from this queue. ++ * ++ * \return \b true if at least one request was removed from the queue. ++ */ bool Dequeue(Item *Owner); -- // Find a Queued item ++ /** \brief Locate an item in this queue. ++ * ++ * \param URI A URI to match against. ++ * \param Owner A pkgAcquire::Worker to match against. ++ * ++ * \return the first item in the queue whose URI is #URI and that ++ * is being downloaded by #Owner. ++ */ QItem *FindItem(string URI,pkgAcquire::Worker *Owner); ++ ++ /** Presumably this should start downloading an item? ++ * ++ * \todo Unimplemented. Implement it or remove? ++ */ bool ItemStart(QItem *Itm,unsigned long Size); ++ ++ /** \brief Remove the given item from this queue and set its state ++ * to pkgAcquire::Item::StatDone. ++ * ++ * If this is the only queue containing the item, the item is also ++ * removed from the main queue by calling pkgAcquire::Dequeue. ++ * ++ * \param Itm The item to remove. ++ * ++ * \return \b true if no errors are encountered. ++ */ bool ItemDone(QItem *Itm); ++ /** \brief Start the worker process associated with this queue. ++ * ++ * If a worker process is already associated with this queue, ++ * this is equivalent to calling Cycle(). ++ * ++ * \return \b true if the startup was successful. ++ */ bool Startup(); ++ ++ /** \brief Shut down the worker process associated with this queue. ++ * ++ * \param Final If \b true, then the process is stopped unconditionally. ++ * Otherwise, it is only stopped if it does not need cleanup ++ * as indicated by the pkgAcqMethod::NeedsCleanup member of ++ * its configuration. ++ * ++ * \return \b true. ++ */ bool Shutdown(bool Final); ++ ++ /** \brief Send idle items to the worker process. ++ * ++ * Fills up the pipeline by inserting idle items into the worker's queue. ++ */ bool Cycle(); ++ ++ /** \brief Check for items that could be enqueued. ++ * ++ * Call this after an item placed in multiple queues has gone from ++ * the pkgAcquire::Item::StatFetching state to the ++ * pkgAcquire::Item::StatIdle state, to possibly refill an empty queue. ++ * This is an alias for Cycle(). ++ * ++ * \todo Why both this and Cycle()? Are they expected to be ++ * different someday? ++ */ void Bump(); ++ /** \brief Create a new Queue. ++ * ++ * \param Name The name of the new queue. ++ * \param Owner The download process that owns the new queue. ++ */ Queue(string Name,pkgAcquire *Owner); ++ ++ /** Shut down all the worker processes associated with this queue ++ * and empty the queue. ++ */ ~Queue(); }; ++/** \brief Iterates over all the URIs being fetched by a pkgAcquire object. */ class pkgAcquire::UriIterator { ++ /** The next queue to iterate over. */ pkgAcquire::Queue *CurQ; ++ /** The item that we currently point at. */ pkgAcquire::Queue::QItem *CurItem; public: -- // Advance to the next item inline void operator ++() {operator ++();}; ++ void operator ++(int) { CurItem = CurItem->Next; @@@ -209,11 -209,11 +550,14 @@@ } }; -- // Accessors inline pkgAcquire::ItemDesc const *operator ->() const {return CurItem;}; inline bool operator !=(UriIterator const &rhs) const {return rhs.CurQ != CurQ || rhs.CurItem != CurItem;}; inline bool operator ==(UriIterator const &rhs) const {return rhs.CurQ == CurQ && rhs.CurItem == CurItem;}; ++ /** \brief Create a new UriIterator. ++ * ++ * \param Q The queue over which this UriIterator should iterate. ++ */ UriIterator(pkgAcquire::Queue *Q) : CurQ(Q), CurItem(0) { while (CurItem == 0 && CurQ != 0) @@@ -224,61 -224,61 +568,200 @@@ } }; --// Configuration information from each method ++/** \brief Information about the properties of a single acquire method. */ struct pkgAcquire::MethodConfig { ++ /** \brief The next link on the acquire method list. ++ * ++ * \todo Why not an STL container? ++ */ MethodConfig *Next; ++ /** \brief The name of this acquire method (e.g., http). */ string Access; ++ /** \brief The implementation version of this acquire method. */ string Version; ++ ++ /** \brief If \b true, only one download queue should be created for this ++ * method. ++ */ bool SingleInstance; ++ ++ /** \brief If \b true, this method supports pipelined downloading. */ bool Pipeline; ++ ++ /** \brief If \b true, the worker process should send the entire ++ * APT configuration tree to the fetch subprocess when it starts ++ * up. ++ */ bool SendConfig; ++ ++ /** \brief If \b true, this fetch method does not require network access; ++ * all files are to be acquired from the local disk. ++ */ bool LocalOnly; ++ ++ /** \brief If \b true, the subprocess has to carry out some cleanup ++ * actions before shutting down. ++ * ++ * For instance, the cdrom method needs to unmount the CD after it ++ * finishes. ++ */ bool NeedsCleanup; ++ ++ /** \brief If \b true, this fetch method acquires files from removable media. */ bool Removable; ++ /** \brief Set up the default method parameters. ++ * ++ * All fields are initialized to NULL, "", or \b false as ++ * appropriate. ++ */ MethodConfig(); }; ++/** \brief A monitor object for downloads controlled by the pkgAcquire class. ++ * ++ * \todo Why protected members? ++ * ++ * \todo Should the double members be uint64_t? ++ */ class pkgAcquireStatus { protected: ++ /** \brief The last time at which this monitor object was updated. */ struct timeval Time; ++ ++ /** \brief The time at which the download started. */ struct timeval StartTime; ++ ++ /** \brief The number of bytes fetched as of the previous call to ++ * pkgAcquireStatus::Pulse, including local items. ++ */ double LastBytes; ++ ++ /** \brief The current rate of download as of the most recent call ++ * to pkgAcquireStatus::Pulse, in bytes per second. ++ */ double CurrentCPS; ++ ++ /** \brief The number of bytes fetched as of the most recent call ++ * to pkgAcquireStatus::Pulse, including local items. ++ */ double CurrentBytes; ++ ++ /** \brief The total number of bytes that need to be fetched. ++ * ++ * \warning This member is inaccurate, as new items might be ++ * enqueued while the download is in progress! ++ */ double TotalBytes; ++ ++ /** \brief The total number of bytes accounted for by items that ++ * were successfully fetched. ++ */ double FetchedBytes; ++ ++ /** \brief The amount of time that has elapsed since the download ++ * started. ++ */ unsigned long ElapsedTime; ++ ++ /** \brief The total number of items that need to be fetched. ++ * ++ * \warning This member is inaccurate, as new items might be ++ * enqueued while the download is in progress! ++ */ unsigned long TotalItems; ++ ++ /** \brief The number of items that have been successfully downloaded. */ unsigned long CurrentItems; public: ++ /** \brief If \b true, the download scheduler should call Pulse() ++ * at the next available opportunity. ++ */ bool Update; ++ ++ /** \brief If \b true, extra Pulse() invocations will be performed. ++ * ++ * With this option set, Pulse() will be called every time that a ++ * download item starts downloading, finishes downloading, or ++ * terminates with an error. ++ */ bool MorePulses; -- // Called by items when they have finished a real download ++ /** \brief Invoked when a local or remote file has been completely fetched. ++ * ++ * \param Size The size of the file fetched. ++ * ++ * \param ResumePoint How much of the file was already fetched. ++ */ virtual void Fetched(unsigned long Size,unsigned long ResumePoint); -- // Called to change media ++ /** \brief Invoked when the user should be prompted to change the ++ * inserted removable media. ++ * ++ * This method should not return until the user has confirmed to ++ * the user interface that the media change is complete. ++ * ++ * \param Media The name of the media type that should be changed. ++ * ++ * \param Drive The identifying name of the drive whose media ++ * should be changed. ++ * ++ * \return \b true if the user confirms the media change, \b ++ * false if it is cancelled. ++ * ++ * \todo This is a horrible blocking monster; it should be CPSed ++ * with prejudice. ++ */ virtual bool MediaChange(string Media,string Drive) = 0; -- // Each of these is called by the workers when an event occures ++ /** \brief Invoked when an item is confirmed to be up-to-date. ++ ++ * For instance, when an HTTP download is informed that the file on ++ * the server was not modified. ++ */ virtual void IMSHit(pkgAcquire::ItemDesc &/*Itm*/) {}; ++ ++ /** \brief Invoked when some of an item's data is fetched. */ virtual void Fetch(pkgAcquire::ItemDesc &/*Itm*/) {}; ++ ++ /** \brief Invoked when an item is successfully and completely fetched. */ virtual void Done(pkgAcquire::ItemDesc &/*Itm*/) {}; ++ ++ /** \brief Invoked when the process of fetching an item encounters ++ * a fatal error. ++ */ virtual void Fail(pkgAcquire::ItemDesc &/*Itm*/) {}; -- virtual bool Pulse(pkgAcquire *Owner); // returns false on user cancel ++ ++ /** \brief Periodically invoked while the Acquire process is underway. ++ * ++ * Subclasses should first call pkgAcquireStatus::Pulse(), then ++ * update their status output. The download process is blocked ++ * while Pulse() is being called. ++ * ++ * \return \b false if the user asked to cancel the whole Acquire process. ++ * ++ * \see pkgAcquire::Run ++ */ ++ virtual bool Pulse(pkgAcquire *Owner); ++ ++ /** \brief Invoked when the Acquire process starts running. */ virtual void Start(); ++ ++ /** \brief Invoked when the Acquire process stops running. */ virtual void Stop(); ++ /** \brief Initialize all counters to 0 and the time to the current time. */ pkgAcquireStatus(); virtual ~pkgAcquireStatus() {}; }; ++/** @} */ ++ #endif diff --combined buildlib/environment.mak.in index f5ee539ac,f5ee539ac..2d28e1c67 --- a/buildlib/environment.mak.in +++ b/buildlib/environment.mak.in @@@ -28,6 -28,6 +28,8 @@@ INLINEDEPFLAG = -M DEBIANDOC_HTML = @DEBIANDOC_HTML@ DEBIANDOC_TEXT = @DEBIANDOC_TEXT@ ++DOXYGEN = @DOXYGEN@ ++ # SGML for the man pages DOCBOOK2MAN := @DOCBOOK2MAN@ diff --combined configure.in index af423be05,6130ab544..f85afae5f --- a/configure.in +++ b/configure.in @@@ -18,7 -18,7 +18,7 @@@ AC_CONFIG_AUX_DIR(buildlib AC_CONFIG_HEADER(include/config.h:buildlib/config.h.in include/apti18n.h:buildlib/apti18n.h.in) dnl -- SET THIS TO THE RELEASE VERSION -- -AC_DEFINE_UNQUOTED(VERSION,"0.6.42.3") +AC_DEFINE_UNQUOTED(VERSION,"0.6.42.3exp1") PACKAGE="apt" AC_DEFINE_UNQUOTED(PACKAGE,"$PACKAGE") AC_SUBST(PACKAGE) @@@ -175,12 -175,12 +175,21 @@@ dnl Check for debiando AC_PATH_PROG(DEBIANDOC_HTML,debiandoc2html) AC_PATH_PROG(DEBIANDOC_TEXT,debiandoc2text) ++dnl Check for doxygen ++AC_PATH_PROG(DOXYGEN, doxygen) ++ dnl Check for the SGML tools needed to build man pages AC_PATH_PROG(DOCBOOK2MAN,docbook2man) dnl Check for the XML tools needed to build man pages AC_PATH_PROG(XMLTO,xmlto) ++dnl Check for graphviz ++AC_CHECK_PROG([HAVE_DOT], [dot], [YES], [NO]) ++AC_PATH_PROG([DOT], [dot], []) ++DOTDIR=$(dirname $DOT) ++AC_SUBST(DOTDIR) ++ dnl Check for YODL dnl AC_CHECK_PROG(YODL_MAN,yodl2man,"yes","") @@@ -200,4 -200,4 +209,4 @@@ f AC_SUBST(USE_NLS) AC_PATH_PROG(BASH, bash) --AC_OUTPUT(environment.mak:buildlib/environment.mak.in makefile:buildlib/makefile.in,make -s dirs) ++AC_OUTPUT(environment.mak:buildlib/environment.mak.in makefile:buildlib/makefile.in doc/Doxyfile,make -s dirs) diff --combined debian/control index 4aa7b5aa2,4aa7b5aa2..6bc9062f8 --- a/debian/control +++ b/debian/control @@@ -4,7 -4,7 +4,7 @@@ Priority: importan Maintainer: APT Development Team Uploaders: Jason Gunthorpe , Adam Heath , Matt Zimmerman , Michael Vogt Standards-Version: 3.6.1 --Build-Depends: debhelper (>= 4.1.62), libdb4.2-dev, gettext (>= 0.12) ++Build-Depends: debhelper (>= 4.1.62), libdb4.2-dev, gettext (>= 0.12), graphviz Build-Depends-Indep: debiandoc-sgml, docbook-utils (>= 0.6.12-1) Package: apt diff --combined doc/Doxyfile.in index 000000000,000000000..f19ff93f6 new file mode 100644 --- /dev/null +++ b/doc/Doxyfile.in @@@ -1,0 -1,0 +1,1238 @@@ ++# Doxyfile 1.4.5 ++ ++# This file describes the settings to be used by the documentation system ++# doxygen (www.doxygen.org) for a project ++# ++# All text after a hash (#) is considered a comment and will be ignored ++# The format is: ++# TAG = value [value, ...] ++# For lists items can also be appended using: ++# TAG += value [value, ...] ++# Values that contain spaces should be placed between quotes (" ") ++ ++#--------------------------------------------------------------------------- ++# Project related configuration options ++#--------------------------------------------------------------------------- ++ ++# The PROJECT_NAME tag is a single word (or a sequence of words surrounded ++# by quotes) that should identify the project. ++ ++PROJECT_NAME = @PACKAGE@ ++ ++# The PROJECT_NUMBER tag can be used to enter a project or revision number. ++# This could be handy for archiving the generated documentation or ++# if some version control system is used. ++ ++PROJECT_NUMBER = @VERSION@ ++ ++# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) ++# base path where the generated documentation will be put. ++# If a relative path is entered, it will be relative to the location ++# where doxygen was started. If left blank the current directory will be used. ++ ++OUTPUT_DIRECTORY = ../build/doc/doxygen ++ ++# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create ++# 4096 sub-directories (in 2 levels) under the output directory of each output ++# format and will distribute the generated files over these directories. ++# Enabling this option can be useful when feeding doxygen a huge amount of ++# source files, where putting all generated files in the same directory would ++# otherwise cause performance problems for the file system. ++ ++CREATE_SUBDIRS = NO ++ ++# The OUTPUT_LANGUAGE tag is used to specify the language in which all ++# documentation generated by doxygen is written. Doxygen will use this ++# information to generate all constant output in the proper language. ++# The default language is English, other supported languages are: ++# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, ++# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, ++# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, ++# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, ++# Swedish, and Ukrainian. ++ ++OUTPUT_LANGUAGE = English ++ ++# This tag can be used to specify the encoding used in the generated output. ++# The encoding is not always determined by the language that is chosen, ++# but also whether or not the output is meant for Windows or non-Windows users. ++# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES ++# forces the Windows encoding (this is the default for the Windows binary), ++# whereas setting the tag to NO uses a Unix-style encoding (the default for ++# all platforms other than Windows). ++ ++USE_WINDOWS_ENCODING = NO ++ ++# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will ++# include brief member descriptions after the members that are listed in ++# the file and class documentation (similar to JavaDoc). ++# Set to NO to disable this. ++ ++BRIEF_MEMBER_DESC = YES ++ ++# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend ++# the brief description of a member or function before the detailed description. ++# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the ++# brief descriptions will be completely suppressed. ++ ++REPEAT_BRIEF = YES ++ ++# This tag implements a quasi-intelligent brief description abbreviator ++# that is used to form the text in various listings. Each string ++# in this list, if found as the leading text of the brief description, will be ++# stripped from the text and the result after processing the whole list, is ++# used as the annotated text. Otherwise, the brief description is used as-is. ++# If left blank, the following values are used ("$name" is automatically ++# replaced with the name of the entity): "The $name class" "The $name widget" ++# "The $name file" "is" "provides" "specifies" "contains" ++# "represents" "a" "an" "the" ++ ++ABBREVIATE_BRIEF = ++ ++# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then ++# Doxygen will generate a detailed section even if there is only a brief ++# description. ++ ++ALWAYS_DETAILED_SEC = NO ++ ++# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all ++# inherited members of a class in the documentation of that class as if those ++# members were ordinary class members. Constructors, destructors and assignment ++# operators of the base classes will not be shown. ++ ++INLINE_INHERITED_MEMB = NO ++ ++# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full ++# path before files name in the file list and in the header files. If set ++# to NO the shortest path that makes the file name unique will be used. ++ ++FULL_PATH_NAMES = YES ++ ++# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag ++# can be used to strip a user-defined part of the path. Stripping is ++# only done if one of the specified strings matches the left-hand part of ++# the path. The tag can be used to show relative paths in the file list. ++# If left blank the directory from which doxygen is run is used as the ++# path to strip. ++ ++STRIP_FROM_PATH = ++ ++# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of ++# the path mentioned in the documentation of a class, which tells ++# the reader which header file to include in order to use a class. ++# If left blank only the name of the header file containing the class ++# definition is used. Otherwise one should specify the include paths that ++# are normally passed to the compiler using the -I flag. ++ ++STRIP_FROM_INC_PATH = ++ ++# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter ++# (but less readable) file names. This can be useful is your file systems ++# doesn't support long names like on DOS, Mac, or CD-ROM. ++ ++SHORT_NAMES = NO ++ ++# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen ++# will interpret the first line (until the first dot) of a JavaDoc-style ++# comment as the brief description. If set to NO, the JavaDoc ++# comments will behave just like the Qt-style comments (thus requiring an ++# explicit @brief command for a brief description. ++ ++JAVADOC_AUTOBRIEF = NO ++ ++# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen ++# treat a multi-line C++ special comment block (i.e. a block of //! or /// ++# comments) as a brief description. This used to be the default behaviour. ++# The new default is to treat a multi-line C++ comment block as a detailed ++# description. Set this tag to YES if you prefer the old behaviour instead. ++ ++MULTILINE_CPP_IS_BRIEF = NO ++ ++# If the DETAILS_AT_TOP tag is set to YES then Doxygen ++# will output the detailed description near the top, like JavaDoc. ++# If set to NO, the detailed description appears after the member ++# documentation. ++ ++DETAILS_AT_TOP = NO ++ ++# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented ++# member inherits the documentation from any documented member that it ++# re-implements. ++ ++INHERIT_DOCS = YES ++ ++# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce ++# a new page for each member. If set to NO, the documentation of a member will ++# be part of the file/class/namespace that contains it. ++ ++SEPARATE_MEMBER_PAGES = NO ++ ++# The TAB_SIZE tag can be used to set the number of spaces in a tab. ++# Doxygen uses this value to replace tabs by spaces in code fragments. ++ ++TAB_SIZE = 8 ++ ++# This tag can be used to specify a number of aliases that acts ++# as commands in the documentation. An alias has the form "name=value". ++# For example adding "sideeffect=\par Side Effects:\n" will allow you to ++# put the command \sideeffect (or @sideeffect) in the documentation, which ++# will result in a user-defined paragraph with heading "Side Effects:". ++# You can put \n's in the value part of an alias to insert newlines. ++ ++ALIASES = ++ ++# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C ++# sources only. Doxygen will then generate output that is more tailored for C. ++# For instance, some of the names that are used will be different. The list ++# of all members will be omitted, etc. ++ ++OPTIMIZE_OUTPUT_FOR_C = NO ++ ++# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java ++# sources only. Doxygen will then generate output that is more tailored for Java. ++# For instance, namespaces will be presented as packages, qualified scopes ++# will look different, etc. ++ ++OPTIMIZE_OUTPUT_JAVA = NO ++ ++# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to ++# include (a tag file for) the STL sources as input, then you should ++# set this tag to YES in order to let doxygen match functions declarations and ++# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. ++# func(std::string) {}). This also make the inheritance and collaboration ++# diagrams that involve STL classes more complete and accurate. ++ ++BUILTIN_STL_SUPPORT = YES ++ ++# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC ++# tag is set to YES, then doxygen will reuse the documentation of the first ++# member in the group (if any) for the other members of the group. By default ++# all members of a group must be documented explicitly. ++ ++DISTRIBUTE_GROUP_DOC = NO ++ ++# Set the SUBGROUPING tag to YES (the default) to allow class member groups of ++# the same type (for instance a group of public functions) to be put as a ++# subgroup of that type (e.g. under the Public Functions section). Set it to ++# NO to prevent subgrouping. Alternatively, this can be done per class using ++# the \nosubgrouping command. ++ ++SUBGROUPING = YES ++ ++#--------------------------------------------------------------------------- ++# Build related configuration options ++#--------------------------------------------------------------------------- ++ ++# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in ++# documentation are documented, even if no documentation was available. ++# Private class members and static file members will be hidden unless ++# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES ++ ++EXTRACT_ALL = NO ++ ++# If the EXTRACT_PRIVATE tag is set to YES all private members of a class ++# will be included in the documentation. ++ ++EXTRACT_PRIVATE = NO ++ ++# If the EXTRACT_STATIC tag is set to YES all static members of a file ++# will be included in the documentation. ++ ++EXTRACT_STATIC = NO ++ ++# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) ++# defined locally in source files will be included in the documentation. ++# If set to NO only classes defined in header files are included. ++ ++EXTRACT_LOCAL_CLASSES = YES ++ ++# This flag is only useful for Objective-C code. When set to YES local ++# methods, which are defined in the implementation section but not in ++# the interface are included in the documentation. ++# If set to NO (the default) only methods in the interface are included. ++ ++EXTRACT_LOCAL_METHODS = NO ++ ++# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all ++# undocumented members of documented classes, files or namespaces. ++# If set to NO (the default) these members will be included in the ++# various overviews, but no documentation section is generated. ++# This option has no effect if EXTRACT_ALL is enabled. ++ ++HIDE_UNDOC_MEMBERS = NO ++ ++# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all ++# undocumented classes that are normally visible in the class hierarchy. ++# If set to NO (the default) these classes will be included in the various ++# overviews. This option has no effect if EXTRACT_ALL is enabled. ++ ++HIDE_UNDOC_CLASSES = NO ++ ++# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all ++# friend (class|struct|union) declarations. ++# If set to NO (the default) these declarations will be included in the ++# documentation. ++ ++HIDE_FRIEND_COMPOUNDS = NO ++ ++# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any ++# documentation blocks found inside the body of a function. ++# If set to NO (the default) these blocks will be appended to the ++# function's detailed documentation block. ++ ++HIDE_IN_BODY_DOCS = NO ++ ++# The INTERNAL_DOCS tag determines if documentation ++# that is typed after a \internal command is included. If the tag is set ++# to NO (the default) then the documentation will be excluded. ++# Set it to YES to include the internal documentation. ++ ++INTERNAL_DOCS = NO ++ ++# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate ++# file names in lower-case letters. If set to YES upper-case letters are also ++# allowed. This is useful if you have classes or files whose names only differ ++# in case and if your file system supports case sensitive file names. Windows ++# and Mac users are advised to set this option to NO. ++ ++CASE_SENSE_NAMES = YES ++ ++# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen ++# will show members with their full class and namespace scopes in the ++# documentation. If set to YES the scope will be hidden. ++ ++HIDE_SCOPE_NAMES = YES ++ ++# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen ++# will put a list of the files that are included by a file in the documentation ++# of that file. ++ ++SHOW_INCLUDE_FILES = YES ++ ++# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] ++# is inserted in the documentation for inline members. ++ ++INLINE_INFO = YES ++ ++# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen ++# will sort the (detailed) documentation of file and class members ++# alphabetically by member name. If set to NO the members will appear in ++# declaration order. ++ ++SORT_MEMBER_DOCS = YES ++ ++# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the ++# brief documentation of file, namespace and class members alphabetically ++# by member name. If set to NO (the default) the members will appear in ++# declaration order. ++ ++SORT_BRIEF_DOCS = NO ++ ++# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be ++# sorted by fully-qualified names, including namespaces. If set to ++# NO (the default), the class list will be sorted only by class name, ++# not including the namespace part. ++# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. ++# Note: This option applies only to the class list, not to the ++# alphabetical list. ++ ++SORT_BY_SCOPE_NAME = NO ++ ++# The GENERATE_TODOLIST tag can be used to enable (YES) or ++# disable (NO) the todo list. This list is created by putting \todo ++# commands in the documentation. ++ ++GENERATE_TODOLIST = YES ++ ++# The GENERATE_TESTLIST tag can be used to enable (YES) or ++# disable (NO) the test list. This list is created by putting \test ++# commands in the documentation. ++ ++GENERATE_TESTLIST = YES ++ ++# The GENERATE_BUGLIST tag can be used to enable (YES) or ++# disable (NO) the bug list. This list is created by putting \bug ++# commands in the documentation. ++ ++GENERATE_BUGLIST = YES ++ ++# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or ++# disable (NO) the deprecated list. This list is created by putting ++# \deprecated commands in the documentation. ++ ++GENERATE_DEPRECATEDLIST= YES ++ ++# The ENABLED_SECTIONS tag can be used to enable conditional ++# documentation sections, marked by \if sectionname ... \endif. ++ ++ENABLED_SECTIONS = ++ ++# The MAX_INITIALIZER_LINES tag determines the maximum number of lines ++# the initial value of a variable or define consists of for it to appear in ++# the documentation. If the initializer consists of more lines than specified ++# here it will be hidden. Use a value of 0 to hide initializers completely. ++# The appearance of the initializer of individual variables and defines in the ++# documentation can be controlled using \showinitializer or \hideinitializer ++# command in the documentation regardless of this setting. ++ ++MAX_INITIALIZER_LINES = 30 ++ ++# Set the SHOW_USED_FILES tag to NO to disable the list of files generated ++# at the bottom of the documentation of classes and structs. If set to YES the ++# list will mention the files that were used to generate the documentation. ++ ++SHOW_USED_FILES = YES ++ ++# If the sources in your project are distributed over multiple directories ++# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy ++# in the documentation. The default is YES. ++ ++SHOW_DIRECTORIES = YES ++ ++# The FILE_VERSION_FILTER tag can be used to specify a program or script that ++# doxygen should invoke to get the current version for each file (typically from the ++# version control system). Doxygen will invoke the program by executing (via ++# popen()) the command , where is the value of ++# the FILE_VERSION_FILTER tag, and is the name of an input file ++# provided by doxygen. Whatever the program writes to standard output ++# is used as the file version. See the manual for examples. ++ ++FILE_VERSION_FILTER = ++ ++#--------------------------------------------------------------------------- ++# configuration options related to warning and progress messages ++#--------------------------------------------------------------------------- ++ ++# The QUIET tag can be used to turn on/off the messages that are generated ++# by doxygen. Possible values are YES and NO. If left blank NO is used. ++ ++QUIET = NO ++ ++# The WARNINGS tag can be used to turn on/off the warning messages that are ++# generated by doxygen. Possible values are YES and NO. If left blank ++# NO is used. ++ ++WARNINGS = YES ++ ++# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings ++# for undocumented members. If EXTRACT_ALL is set to YES then this flag will ++# automatically be disabled. ++ ++WARN_IF_UNDOCUMENTED = YES ++ ++# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for ++# potential errors in the documentation, such as not documenting some ++# parameters in a documented function, or documenting parameters that ++# don't exist or using markup commands wrongly. ++ ++WARN_IF_DOC_ERROR = YES ++ ++# This WARN_NO_PARAMDOC option can be abled to get warnings for ++# functions that are documented, but have no documentation for their parameters ++# or return value. If set to NO (the default) doxygen will only warn about ++# wrong or incomplete parameter documentation, but not about the absence of ++# documentation. ++ ++WARN_NO_PARAMDOC = NO ++ ++# The WARN_FORMAT tag determines the format of the warning messages that ++# doxygen can produce. The string should contain the $file, $line, and $text ++# tags, which will be replaced by the file and line number from which the ++# warning originated and the warning text. Optionally the format may contain ++# $version, which will be replaced by the version of the file (if it could ++# be obtained via FILE_VERSION_FILTER) ++ ++WARN_FORMAT = "$file:$line: $text" ++ ++# The WARN_LOGFILE tag can be used to specify a file to which warning ++# and error messages should be written. If left blank the output is written ++# to stderr. ++ ++WARN_LOGFILE = ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the input files ++#--------------------------------------------------------------------------- ++ ++# The INPUT tag can be used to specify the files and/or directories that contain ++# documented source files. You may enter file names like "myfile.cpp" or ++# directories like "/usr/src/myproject". Separate the files or directories ++# with spaces. ++ ++INPUT = ../apt-pkg ++ ++# If the value of the INPUT tag contains directories, you can use the ++# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp ++# and *.h) to filter out the source-files in the directories. If left ++# blank the following patterns are tested: ++# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx ++# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py ++ ++FILE_PATTERNS = *.cc \ ++ *.h ++ ++# The RECURSIVE tag can be used to turn specify whether or not subdirectories ++# should be searched for input files as well. Possible values are YES and NO. ++# If left blank NO is used. ++ ++RECURSIVE = YES ++ ++# The EXCLUDE tag can be used to specify files and/or directories that should ++# excluded from the INPUT source files. This way you can easily exclude a ++# subdirectory from a directory tree whose root is specified with the INPUT tag. ++ ++EXCLUDE = ++ ++# The EXCLUDE_SYMLINKS tag can be used select whether or not files or ++# directories that are symbolic links (a Unix filesystem feature) are excluded ++# from the input. ++ ++EXCLUDE_SYMLINKS = NO ++ ++# If the value of the INPUT tag contains directories, you can use the ++# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude ++# certain files from those directories. Note that the wildcards are matched ++# against the file with absolute path, so to exclude all test directories ++# for example use the pattern */test/* ++ ++EXCLUDE_PATTERNS = ++ ++# The EXAMPLE_PATH tag can be used to specify one or more files or ++# directories that contain example code fragments that are included (see ++# the \include command). ++ ++EXAMPLE_PATH = ++ ++# If the value of the EXAMPLE_PATH tag contains directories, you can use the ++# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp ++# and *.h) to filter out the source-files in the directories. If left ++# blank all files are included. ++ ++EXAMPLE_PATTERNS = ++ ++# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be ++# searched for input files to be used with the \include or \dontinclude ++# commands irrespective of the value of the RECURSIVE tag. ++# Possible values are YES and NO. If left blank NO is used. ++ ++EXAMPLE_RECURSIVE = NO ++ ++# The IMAGE_PATH tag can be used to specify one or more files or ++# directories that contain image that are included in the documentation (see ++# the \image command). ++ ++IMAGE_PATH = ++ ++# The INPUT_FILTER tag can be used to specify a program that doxygen should ++# invoke to filter for each input file. Doxygen will invoke the filter program ++# by executing (via popen()) the command , where ++# is the value of the INPUT_FILTER tag, and is the name of an ++# input file. Doxygen will then use the output that the filter program writes ++# to standard output. If FILTER_PATTERNS is specified, this tag will be ++# ignored. ++ ++INPUT_FILTER = ++ ++# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern ++# basis. Doxygen will compare the file name with each pattern and apply the ++# filter if there is a match. The filters are a list of the form: ++# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further ++# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER ++# is applied to all files. ++ ++FILTER_PATTERNS = ++ ++# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using ++# INPUT_FILTER) will be used to filter the input files when producing source ++# files to browse (i.e. when SOURCE_BROWSER is set to YES). ++ ++FILTER_SOURCE_FILES = NO ++ ++#--------------------------------------------------------------------------- ++# configuration options related to source browsing ++#--------------------------------------------------------------------------- ++ ++# If the SOURCE_BROWSER tag is set to YES then a list of source files will ++# be generated. Documented entities will be cross-referenced with these sources. ++# Note: To get rid of all source code in the generated output, make sure also ++# VERBATIM_HEADERS is set to NO. ++ ++SOURCE_BROWSER = NO ++ ++# Setting the INLINE_SOURCES tag to YES will include the body ++# of functions and classes directly in the documentation. ++ ++INLINE_SOURCES = NO ++ ++# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct ++# doxygen to hide any special comment blocks from generated source code ++# fragments. Normal C and C++ comments will always remain visible. ++ ++STRIP_CODE_COMMENTS = YES ++ ++# If the REFERENCED_BY_RELATION tag is set to YES (the default) ++# then for each documented function all documented ++# functions referencing it will be listed. ++ ++REFERENCED_BY_RELATION = YES ++ ++# If the REFERENCES_RELATION tag is set to YES (the default) ++# then for each documented function all documented entities ++# called/used by that function will be listed. ++ ++REFERENCES_RELATION = YES ++ ++# If the USE_HTAGS tag is set to YES then the references to source code ++# will point to the HTML generated by the htags(1) tool instead of doxygen ++# built-in source browser. The htags tool is part of GNU's global source ++# tagging system (see http://www.gnu.org/software/global/global.html). You ++# will need version 4.8.6 or higher. ++ ++USE_HTAGS = NO ++ ++# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen ++# will generate a verbatim copy of the header file for each class for ++# which an include is specified. Set to NO to disable this. ++ ++VERBATIM_HEADERS = YES ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the alphabetical class index ++#--------------------------------------------------------------------------- ++ ++# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index ++# of all compounds will be generated. Enable this if the project ++# contains a lot of classes, structs, unions or interfaces. ++ ++ALPHABETICAL_INDEX = NO ++ ++# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then ++# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns ++# in which this list will be split (can be a number in the range [1..20]) ++ ++COLS_IN_ALPHA_INDEX = 5 ++ ++# In case all classes in a project start with a common prefix, all ++# classes will be put under the same header in the alphabetical index. ++# The IGNORE_PREFIX tag can be used to specify one or more prefixes that ++# should be ignored while generating the index headers. ++ ++IGNORE_PREFIX = ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the HTML output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_HTML tag is set to YES (the default) Doxygen will ++# generate HTML output. ++ ++GENERATE_HTML = YES ++ ++# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. ++# If a relative path is entered the value of OUTPUT_DIRECTORY will be ++# put in front of it. If left blank `html' will be used as the default path. ++ ++HTML_OUTPUT = html ++ ++# The HTML_FILE_EXTENSION tag can be used to specify the file extension for ++# each generated HTML page (for example: .htm,.php,.asp). If it is left blank ++# doxygen will generate files with .html extension. ++ ++HTML_FILE_EXTENSION = .html ++ ++# The HTML_HEADER tag can be used to specify a personal HTML header for ++# each generated HTML page. If it is left blank doxygen will generate a ++# standard header. ++ ++HTML_HEADER = ++ ++# The HTML_FOOTER tag can be used to specify a personal HTML footer for ++# each generated HTML page. If it is left blank doxygen will generate a ++# standard footer. ++ ++HTML_FOOTER = ++ ++# The HTML_STYLESHEET tag can be used to specify a user-defined cascading ++# style sheet that is used by each HTML page. It can be used to ++# fine-tune the look of the HTML output. If the tag is left blank doxygen ++# will generate a default style sheet. Note that doxygen will try to copy ++# the style sheet file to the HTML output directory, so don't put your own ++# stylesheet in the HTML output directory as well, or it will be erased! ++ ++HTML_STYLESHEET = ++ ++# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, ++# files or namespaces will be aligned in HTML using tables. If set to ++# NO a bullet list will be used. ++ ++HTML_ALIGN_MEMBERS = YES ++ ++# If the GENERATE_HTMLHELP tag is set to YES, additional index files ++# will be generated that can be used as input for tools like the ++# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) ++# of the generated HTML documentation. ++ ++GENERATE_HTMLHELP = NO ++ ++# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can ++# be used to specify the file name of the resulting .chm file. You ++# can add a path in front of the file if the result should not be ++# written to the html output directory. ++ ++CHM_FILE = ++ ++# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can ++# be used to specify the location (absolute path including file name) of ++# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run ++# the HTML help compiler on the generated index.hhp. ++ ++HHC_LOCATION = ++ ++# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag ++# controls if a separate .chi index file is generated (YES) or that ++# it should be included in the master .chm file (NO). ++ ++GENERATE_CHI = NO ++ ++# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag ++# controls whether a binary table of contents is generated (YES) or a ++# normal table of contents (NO) in the .chm file. ++ ++BINARY_TOC = NO ++ ++# The TOC_EXPAND flag can be set to YES to add extra items for group members ++# to the contents of the HTML help documentation and to the tree view. ++ ++TOC_EXPAND = NO ++ ++# The DISABLE_INDEX tag can be used to turn on/off the condensed index at ++# top of each HTML page. The value NO (the default) enables the index and ++# the value YES disables it. ++ ++DISABLE_INDEX = NO ++ ++# This tag can be used to set the number of enum values (range [1..20]) ++# that doxygen will group on one line in the generated HTML documentation. ++ ++ENUM_VALUES_PER_LINE = 4 ++ ++# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be ++# generated containing a tree-like index structure (just like the one that ++# is generated for HTML Help). For this to work a browser that supports ++# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, ++# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are ++# probably better off using the HTML help feature. ++ ++GENERATE_TREEVIEW = NO ++ ++# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be ++# used to set the initial width (in pixels) of the frame in which the tree ++# is shown. ++ ++TREEVIEW_WIDTH = 250 ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the LaTeX output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will ++# generate Latex output. ++ ++GENERATE_LATEX = YES ++ ++# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. ++# If a relative path is entered the value of OUTPUT_DIRECTORY will be ++# put in front of it. If left blank `latex' will be used as the default path. ++ ++LATEX_OUTPUT = latex ++ ++# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be ++# invoked. If left blank `latex' will be used as the default command name. ++ ++LATEX_CMD_NAME = latex ++ ++# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to ++# generate index for LaTeX. If left blank `makeindex' will be used as the ++# default command name. ++ ++MAKEINDEX_CMD_NAME = makeindex ++ ++# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact ++# LaTeX documents. This may be useful for small projects and may help to ++# save some trees in general. ++ ++COMPACT_LATEX = NO ++ ++# The PAPER_TYPE tag can be used to set the paper type that is used ++# by the printer. Possible values are: a4, a4wide, letter, legal and ++# executive. If left blank a4wide will be used. ++ ++PAPER_TYPE = a4wide ++ ++# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX ++# packages that should be included in the LaTeX output. ++ ++EXTRA_PACKAGES = ++ ++# The LATEX_HEADER tag can be used to specify a personal LaTeX header for ++# the generated latex document. The header should contain everything until ++# the first chapter. If it is left blank doxygen will generate a ++# standard header. Notice: only use this tag if you know what you are doing! ++ ++LATEX_HEADER = ++ ++# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated ++# is prepared for conversion to pdf (using ps2pdf). The pdf file will ++# contain links (just like the HTML output) instead of page references ++# This makes the output suitable for online browsing using a pdf viewer. ++ ++PDF_HYPERLINKS = NO ++ ++# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of ++# plain latex in the generated Makefile. Set this option to YES to get a ++# higher quality PDF documentation. ++ ++USE_PDFLATEX = NO ++ ++# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. ++# command to the generated LaTeX files. This will instruct LaTeX to keep ++# running if errors occur, instead of asking the user for help. ++# This option is also used when generating formulas in HTML. ++ ++LATEX_BATCHMODE = NO ++ ++# If LATEX_HIDE_INDICES is set to YES then doxygen will not ++# include the index chapters (such as File Index, Compound Index, etc.) ++# in the output. ++ ++LATEX_HIDE_INDICES = NO ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the RTF output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output ++# The RTF output is optimized for Word 97 and may not look very pretty with ++# other RTF readers or editors. ++ ++GENERATE_RTF = NO ++ ++# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. ++# If a relative path is entered the value of OUTPUT_DIRECTORY will be ++# put in front of it. If left blank `rtf' will be used as the default path. ++ ++RTF_OUTPUT = rtf ++ ++# If the COMPACT_RTF tag is set to YES Doxygen generates more compact ++# RTF documents. This may be useful for small projects and may help to ++# save some trees in general. ++ ++COMPACT_RTF = NO ++ ++# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated ++# will contain hyperlink fields. The RTF file will ++# contain links (just like the HTML output) instead of page references. ++# This makes the output suitable for online browsing using WORD or other ++# programs which support those fields. ++# Note: wordpad (write) and others do not support links. ++ ++RTF_HYPERLINKS = NO ++ ++# Load stylesheet definitions from file. Syntax is similar to doxygen's ++# config file, i.e. a series of assignments. You only have to provide ++# replacements, missing definitions are set to their default value. ++ ++RTF_STYLESHEET_FILE = ++ ++# Set optional variables used in the generation of an rtf document. ++# Syntax is similar to doxygen's config file. ++ ++RTF_EXTENSIONS_FILE = ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the man page output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_MAN tag is set to YES (the default) Doxygen will ++# generate man pages ++ ++GENERATE_MAN = NO ++ ++# The MAN_OUTPUT tag is used to specify where the man pages will be put. ++# If a relative path is entered the value of OUTPUT_DIRECTORY will be ++# put in front of it. If left blank `man' will be used as the default path. ++ ++MAN_OUTPUT = man ++ ++# The MAN_EXTENSION tag determines the extension that is added to ++# the generated man pages (default is the subroutine's section .3) ++ ++MAN_EXTENSION = .3 ++ ++# If the MAN_LINKS tag is set to YES and Doxygen generates man output, ++# then it will generate one additional man file for each entity ++# documented in the real man page(s). These additional files ++# only source the real man page, but without them the man command ++# would be unable to find the correct page. The default is NO. ++ ++MAN_LINKS = NO ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the XML output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_XML tag is set to YES Doxygen will ++# generate an XML file that captures the structure of ++# the code including all documentation. ++ ++GENERATE_XML = NO ++ ++# The XML_OUTPUT tag is used to specify where the XML pages will be put. ++# If a relative path is entered the value of OUTPUT_DIRECTORY will be ++# put in front of it. If left blank `xml' will be used as the default path. ++ ++XML_OUTPUT = xml ++ ++# The XML_SCHEMA tag can be used to specify an XML schema, ++# which can be used by a validating XML parser to check the ++# syntax of the XML files. ++ ++XML_SCHEMA = ++ ++# The XML_DTD tag can be used to specify an XML DTD, ++# which can be used by a validating XML parser to check the ++# syntax of the XML files. ++ ++XML_DTD = ++ ++# If the XML_PROGRAMLISTING tag is set to YES Doxygen will ++# dump the program listings (including syntax highlighting ++# and cross-referencing information) to the XML output. Note that ++# enabling this will significantly increase the size of the XML output. ++ ++XML_PROGRAMLISTING = YES ++ ++#--------------------------------------------------------------------------- ++# configuration options for the AutoGen Definitions output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will ++# generate an AutoGen Definitions (see autogen.sf.net) file ++# that captures the structure of the code including all ++# documentation. Note that this feature is still experimental ++# and incomplete at the moment. ++ ++GENERATE_AUTOGEN_DEF = NO ++ ++#--------------------------------------------------------------------------- ++# configuration options related to the Perl module output ++#--------------------------------------------------------------------------- ++ ++# If the GENERATE_PERLMOD tag is set to YES Doxygen will ++# generate a Perl module file that captures the structure of ++# the code including all documentation. Note that this ++# feature is still experimental and incomplete at the ++# moment. ++ ++GENERATE_PERLMOD = NO ++ ++# If the PERLMOD_LATEX tag is set to YES Doxygen will generate ++# the necessary Makefile rules, Perl scripts and LaTeX code to be able ++# to generate PDF and DVI output from the Perl module output. ++ ++PERLMOD_LATEX = NO ++ ++# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be ++# nicely formatted so it can be parsed by a human reader. This is useful ++# if you want to understand what is going on. On the other hand, if this ++# tag is set to NO the size of the Perl module output will be much smaller ++# and Perl will parse it just the same. ++ ++PERLMOD_PRETTY = YES ++ ++# The names of the make variables in the generated doxyrules.make file ++# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. ++# This is useful so different doxyrules.make files included by the same ++# Makefile don't overwrite each other's variables. ++ ++PERLMOD_MAKEVAR_PREFIX = ++ ++#--------------------------------------------------------------------------- ++# Configuration options related to the preprocessor ++#--------------------------------------------------------------------------- ++ ++# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will ++# evaluate all C-preprocessor directives found in the sources and include ++# files. ++ ++ENABLE_PREPROCESSING = YES ++ ++# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro ++# names in the source code. If set to NO (the default) only conditional ++# compilation will be performed. Macro expansion can be done in a controlled ++# way by setting EXPAND_ONLY_PREDEF to YES. ++ ++MACRO_EXPANSION = NO ++ ++# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES ++# then the macro expansion is limited to the macros specified with the ++# PREDEFINED and EXPAND_AS_DEFINED tags. ++ ++EXPAND_ONLY_PREDEF = NO ++ ++# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files ++# in the INCLUDE_PATH (see below) will be search if a #include is found. ++ ++SEARCH_INCLUDES = YES ++ ++# The INCLUDE_PATH tag can be used to specify one or more directories that ++# contain include files that are not input files but should be processed by ++# the preprocessor. ++ ++INCLUDE_PATH = ++ ++# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard ++# patterns (like *.h and *.hpp) to filter out the header-files in the ++# directories. If left blank, the patterns specified with FILE_PATTERNS will ++# be used. ++ ++INCLUDE_FILE_PATTERNS = ++ ++# The PREDEFINED tag can be used to specify one or more macro names that ++# are defined before the preprocessor is started (similar to the -D option of ++# gcc). The argument of the tag is a list of macros of the form: name ++# or name=definition (no spaces). If the definition and the = are ++# omitted =1 is assumed. To prevent a macro definition from being ++# undefined via #undef or recursively expanded use the := operator ++# instead of the = operator. ++ ++PREDEFINED = ++ ++# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then ++# this tag can be used to specify a list of macro names that should be expanded. ++# The macro definition that is found in the sources will be used. ++# Use the PREDEFINED tag if you want to use a different macro definition. ++ ++EXPAND_AS_DEFINED = ++ ++# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then ++# doxygen's preprocessor will remove all function-like macros that are alone ++# on a line, have an all uppercase name, and do not end with a semicolon. Such ++# function macros are typically used for boiler-plate code, and will confuse ++# the parser if not removed. ++ ++SKIP_FUNCTION_MACROS = YES ++ ++#--------------------------------------------------------------------------- ++# Configuration::additions related to external references ++#--------------------------------------------------------------------------- ++ ++# The TAGFILES option can be used to specify one or more tagfiles. ++# Optionally an initial location of the external documentation ++# can be added for each tagfile. The format of a tag file without ++# this location is as follows: ++# TAGFILES = file1 file2 ... ++# Adding location for the tag files is done as follows: ++# TAGFILES = file1=loc1 "file2 = loc2" ... ++# where "loc1" and "loc2" can be relative or absolute paths or ++# URLs. If a location is present for each tag, the installdox tool ++# does not have to be run to correct the links. ++# Note that each tag file must have a unique name ++# (where the name does NOT include the path) ++# If a tag file is not located in the directory in which doxygen ++# is run, you must also specify the path to the tagfile here. ++ ++TAGFILES = ++ ++# When a file name is specified after GENERATE_TAGFILE, doxygen will create ++# a tag file that is based on the input files it reads. ++ ++GENERATE_TAGFILE = ++ ++# If the ALLEXTERNALS tag is set to YES all external classes will be listed ++# in the class index. If set to NO only the inherited external classes ++# will be listed. ++ ++ALLEXTERNALS = NO ++ ++# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed ++# in the modules index. If set to NO, only the current project's groups will ++# be listed. ++ ++EXTERNAL_GROUPS = YES ++ ++# The PERL_PATH should be the absolute path and name of the perl script ++# interpreter (i.e. the result of `which perl'). ++ ++PERL_PATH = /usr/bin/perl ++ ++#--------------------------------------------------------------------------- ++# Configuration options related to the dot tool ++#--------------------------------------------------------------------------- ++ ++# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will ++# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base ++# or super classes. Setting the tag to NO turns the diagrams off. Note that ++# this option is superseded by the HAVE_DOT option below. This is only a ++# fallback. It is recommended to install and use dot, since it yields more ++# powerful graphs. ++ ++CLASS_DIAGRAMS = YES ++ ++# If set to YES, the inheritance and collaboration graphs will hide ++# inheritance and usage relations if the target is undocumented ++# or is not a class. ++ ++HIDE_UNDOC_RELATIONS = YES ++ ++# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is ++# available from the path. This tool is part of Graphviz, a graph visualization ++# toolkit from AT&T and Lucent Bell Labs. The other options in this section ++# have no effect if this option is set to NO (the default) ++ ++HAVE_DOT = @HAVE_DOT@ ++ ++# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen ++# will generate a graph for each documented class showing the direct and ++# indirect inheritance relations. Setting this tag to YES will force the ++# the CLASS_DIAGRAMS tag to NO. ++ ++CLASS_GRAPH = YES ++ ++# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen ++# will generate a graph for each documented class showing the direct and ++# indirect implementation dependencies (inheritance, containment, and ++# class references variables) of the class with other documented classes. ++ ++COLLABORATION_GRAPH = YES ++ ++# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen ++# will generate a graph for groups, showing the direct groups dependencies ++ ++GROUP_GRAPHS = YES ++ ++# If the UML_LOOK tag is set to YES doxygen will generate inheritance and ++# collaboration diagrams in a style similar to the OMG's Unified Modeling ++# Language. ++ ++UML_LOOK = NO ++ ++# If set to YES, the inheritance and collaboration graphs will show the ++# relations between templates and their instances. ++ ++TEMPLATE_RELATIONS = NO ++ ++# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT ++# tags are set to YES then doxygen will generate a graph for each documented ++# file showing the direct and indirect include dependencies of the file with ++# other documented files. ++ ++INCLUDE_GRAPH = YES ++ ++# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and ++# HAVE_DOT tags are set to YES then doxygen will generate a graph for each ++# documented header file showing the documented files that directly or ++# indirectly include this file. ++ ++INCLUDED_BY_GRAPH = YES ++ ++# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will ++# generate a call dependency graph for every global function or class method. ++# Note that enabling this option will significantly increase the time of a run. ++# So in most cases it will be better to enable call graphs for selected ++# functions only using the \callgraph command. ++ ++CALL_GRAPH = NO ++ ++# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen ++# will graphical hierarchy of all classes instead of a textual one. ++ ++GRAPHICAL_HIERARCHY = YES ++ ++# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES ++# then doxygen will show the dependencies a directory has on other directories ++# in a graphical way. The dependency relations are determined by the #include ++# relations between the files in the directories. ++ ++DIRECTORY_GRAPH = YES ++ ++# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images ++# generated by dot. Possible values are png, jpg, or gif ++# If left blank png will be used. ++ ++DOT_IMAGE_FORMAT = png ++ ++# The tag DOT_PATH can be used to specify the path where the dot tool can be ++# found. If left blank, it is assumed the dot tool can be found in the path. ++ ++DOT_PATH = @DOTDIR@ ++ ++# The DOTFILE_DIRS tag can be used to specify one or more directories that ++# contain dot files that are included in the documentation (see the ++# \dotfile command). ++ ++DOTFILE_DIRS = ++ ++# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width ++# (in pixels) of the graphs generated by dot. If a graph becomes larger than ++# this value, doxygen will try to truncate the graph, so that it fits within ++# the specified constraint. Beware that most browsers cannot cope with very ++# large images. ++ ++MAX_DOT_GRAPH_WIDTH = 1024 ++ ++# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height ++# (in pixels) of the graphs generated by dot. If a graph becomes larger than ++# this value, doxygen will try to truncate the graph, so that it fits within ++# the specified constraint. Beware that most browsers cannot cope with very ++# large images. ++ ++MAX_DOT_GRAPH_HEIGHT = 1024 ++ ++# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the ++# graphs generated by dot. A depth value of 3 means that only nodes reachable ++# from the root by following a path via at most 3 edges will be shown. Nodes ++# that lay further from the root node will be omitted. Note that setting this ++# option to 1 or 2 may greatly reduce the computation time needed for large ++# code bases. Also note that a graph may be further truncated if the graph's ++# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH ++# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), ++# the graph is not depth-constrained. ++ ++MAX_DOT_GRAPH_DEPTH = 0 ++ ++# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent ++# background. This is disabled by default, which results in a white background. ++# Warning: Depending on the platform used, enabling this option may lead to ++# badly anti-aliased labels on the edges of a graph (i.e. they become hard to ++# read). ++ ++DOT_TRANSPARENT = NO ++ ++# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output ++# files in one run (i.e. multiple -o and -T options on the command line). This ++# makes dot run faster, but since only newer versions of dot (>1.8.10) ++# support this, this feature is disabled by default. ++ ++DOT_MULTI_TARGETS = NO ++ ++# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will ++# generate a legend page explaining the meaning of the various boxes and ++# arrows in the dot generated graphs. ++ ++GENERATE_LEGEND = YES ++ ++# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will ++# remove the intermediate dot files that are used to generate ++# the various graphs. ++ ++DOT_CLEANUP = YES ++ ++#--------------------------------------------------------------------------- ++# Configuration::additions related to the search engine ++#--------------------------------------------------------------------------- ++ ++# The SEARCHENGINE tag specifies whether or not a search engine should be ++# used. If set to NO the values of all tags below this one will be ignored. ++ ++SEARCHENGINE = NO diff --combined doc/makefile index 31ee061fb,31ee061fb..5f774b825 --- a/doc/makefile +++ b/doc/makefile @@@ -42,3 -42,3 +42,24 @@@ doc.ja: %.ja doc.pl: %.pl: $(MAKE) -C pl $* ++ ++ifdef DOXYGEN ++DOXYGEN_SOURCES = $(shell find $(BASE)/apt-pkg -not -name .\\\#* -and \( -name \*.cc -or -name \*.h \) ) ++ ++clean: doxygen-clean ++ ++doxygen-clean: ++ rm -fr $(BUILD)/doc/doxygen ++ rm -f $(BUILD)/doc/doxygen-stamp ++ ++$(BUILD)/doc/Doxyfile: Doxyfile.in ++ (cd $(BUILD) && ./config.status doc/Doxyfile) ++ ++$(BUILD)/doc/doxygen-stamp: $(DOXYGEN_SOURCES) $(BUILD)/doc/Doxyfile ++ rm -fr $(BUILD)/doc/doxygen ++ $(DOXYGEN) $(BUILD)/doc/Doxyfile ++ touch $(BUILD)/doc/doxygen-stamp ++ ++doc: $(BUILD)/doc/doxygen-stamp ++ ++endif