0746951be1
* Finish converting existing comments for internal API docs 99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from #8133 * Fix two things from comments * Use triple-backtick not indent for `dumpPath` * Convert GNU-style `\`..'` quotes to markdown style in API docs This will render correctly.
152 lines
3.7 KiB
C++
152 lines
3.7 KiB
C++
#pragma once
|
|
///@file
|
|
|
|
#include "util.hh"
|
|
#include "args.hh"
|
|
#include "common-args.hh"
|
|
#include "path.hh"
|
|
#include "derived-path.hh"
|
|
|
|
#include <signal.h>
|
|
|
|
#include <locale>
|
|
|
|
|
|
namespace nix {
|
|
|
|
class Exit : public std::exception
|
|
{
|
|
public:
|
|
int status;
|
|
Exit() : status(0) { }
|
|
Exit(int status) : status(status) { }
|
|
virtual ~Exit();
|
|
};
|
|
|
|
int handleExceptions(const std::string & programName, std::function<void()> fun);
|
|
|
|
/**
|
|
* Don't forget to call initPlugins() after settings are initialized!
|
|
*/
|
|
void initNix();
|
|
|
|
void parseCmdLine(int argc, char * * argv,
|
|
std::function<bool(Strings::iterator & arg, const Strings::iterator & end)> parseArg);
|
|
|
|
void parseCmdLine(const std::string & programName, const Strings & args,
|
|
std::function<bool(Strings::iterator & arg, const Strings::iterator & end)> parseArg);
|
|
|
|
void printVersion(const std::string & programName);
|
|
|
|
/**
|
|
* Ugh. No better place to put this.
|
|
*/
|
|
void printGCWarning();
|
|
|
|
class Store;
|
|
|
|
void printMissing(
|
|
ref<Store> store,
|
|
const std::vector<DerivedPath> & paths,
|
|
Verbosity lvl = lvlInfo);
|
|
|
|
void printMissing(ref<Store> store, const StorePathSet & willBuild,
|
|
const StorePathSet & willSubstitute, const StorePathSet & unknown,
|
|
uint64_t downloadSize, uint64_t narSize, Verbosity lvl = lvlInfo);
|
|
|
|
std::string getArg(const std::string & opt,
|
|
Strings::iterator & i, const Strings::iterator & end);
|
|
|
|
template<class N> N getIntArg(const std::string & opt,
|
|
Strings::iterator & i, const Strings::iterator & end, bool allowUnit)
|
|
{
|
|
++i;
|
|
if (i == end) throw UsageError("'%1%' requires an argument", opt);
|
|
return string2IntWithUnitPrefix<N>(*i);
|
|
}
|
|
|
|
|
|
struct LegacyArgs : public MixCommonArgs
|
|
{
|
|
std::function<bool(Strings::iterator & arg, const Strings::iterator & end)> parseArg;
|
|
|
|
LegacyArgs(const std::string & programName,
|
|
std::function<bool(Strings::iterator & arg, const Strings::iterator & end)> parseArg);
|
|
|
|
bool processFlag(Strings::iterator & pos, Strings::iterator end) override;
|
|
|
|
bool processArgs(const Strings & args, bool finish) override;
|
|
};
|
|
|
|
|
|
/**
|
|
* Show the manual page for the specified program.
|
|
*/
|
|
void showManPage(const std::string & name);
|
|
|
|
/**
|
|
* The constructor of this class starts a pager if stdout is a
|
|
* terminal and $PAGER is set. Stdout is redirected to the pager.
|
|
*/
|
|
class RunPager
|
|
{
|
|
public:
|
|
RunPager();
|
|
~RunPager();
|
|
|
|
private:
|
|
Pid pid;
|
|
int stdout;
|
|
};
|
|
|
|
extern volatile ::sig_atomic_t blockInt;
|
|
|
|
|
|
/* GC helpers. */
|
|
|
|
std::string showBytes(uint64_t bytes);
|
|
|
|
struct GCResults;
|
|
|
|
struct PrintFreed
|
|
{
|
|
bool show;
|
|
const GCResults & results;
|
|
PrintFreed(bool show, const GCResults & results)
|
|
: show(show), results(results) { }
|
|
~PrintFreed();
|
|
};
|
|
|
|
|
|
/**
|
|
* Install a SIGSEGV handler to detect stack overflows.
|
|
*/
|
|
void detectStackOverflow();
|
|
|
|
/**
|
|
* Pluggable behavior to run in case of a stack overflow.
|
|
*
|
|
* Default value: defaultStackOverflowHandler.
|
|
*
|
|
* This is called by the handler installed by detectStackOverflow().
|
|
*
|
|
* This gives Nix library consumers a limit opportunity to report the error
|
|
* condition. The handler should exit the process.
|
|
* See defaultStackOverflowHandler() for a reference implementation.
|
|
*
|
|
* NOTE: Use with diligence, because this runs in the signal handler, with very
|
|
* limited stack space and a potentially a corrupted heap, all while the failed
|
|
* thread is blocked indefinitely. All functions called must be reentrant.
|
|
*/
|
|
extern std::function<void(siginfo_t * info, void * ctx)> stackOverflowHandler;
|
|
|
|
/**
|
|
* The default, robust implementation of stackOverflowHandler.
|
|
*
|
|
* Prints an error message directly to stderr using a syscall instead of the
|
|
* logger. Exits the process immediately after.
|
|
*/
|
|
void defaultStackOverflowHandler(siginfo_t * info, void * ctx);
|
|
|
|
}
|