skyrelia
ba1c9d52ec
This cleans up includes that clangd reports as unused, usually by deleting the offending include. The process was to delete an include and see if it still builds. If not, try to find a more specific include(s) that works, that was previously transitively included. If the original include seems intended to re-export said transitive include, mark the transitive include as `// IWYU pragma: export`. Otherwise, replace the original include with the transitive include(s). If none of the above applies, because the original file depends on code directly in the include somehow, or the direct include is an external dependency that cannot be modified, restore the original include and mark it as `// IWYU pragma: keep`. Change-Id: I5ce3d34dad76b0cad0a6a7990fea13add393aad3
84 lines
2.5 KiB
C++
84 lines
2.5 KiB
C++
#pragma once
|
|
/**
|
|
* @file
|
|
* @brief Common printing functions for the Nix language
|
|
*
|
|
* While most types come with their own methods for printing, they share some
|
|
* functions that are placed here.
|
|
*/
|
|
|
|
#include <iostream>
|
|
|
|
#include "lix/libutil/fmt.hh"
|
|
#include "lix/libexpr/print-options.hh"
|
|
|
|
namespace nix {
|
|
|
|
struct Expr;
|
|
|
|
class EvalState;
|
|
struct Value;
|
|
|
|
/** Print `true` or `false`. */
|
|
std::ostream & printLiteralBool(std::ostream & o, bool b);
|
|
|
|
/**
|
|
* Print a string as an attribute name in the Nix expression language syntax.
|
|
*
|
|
* Prints a quoted string if necessary.
|
|
*/
|
|
std::ostream & printAttributeName(std::ostream & o, std::string_view s);
|
|
|
|
/**
|
|
* Returns `true' is a string is a reserved keyword which requires quotation
|
|
* when printing attribute set field names.
|
|
*/
|
|
bool isReservedKeyword(const std::string_view str);
|
|
|
|
/**
|
|
* Print a string as an identifier in the Nix expression language syntax.
|
|
*
|
|
* FIXME: "identifier" is ambiguous. Identifiers do not have a single
|
|
* textual representation. They can be used in variable references,
|
|
* let bindings, left-hand sides or attribute names in a select
|
|
* expression, or something else entirely, like JSON. Use one of the
|
|
* `print*` functions instead.
|
|
*/
|
|
std::ostream & printIdentifier(std::ostream & o, std::string_view s);
|
|
|
|
void printValue(EvalState & state, std::ostream & str, Value & v, PrintOptions options = PrintOptions {});
|
|
|
|
/**
|
|
* A partially-applied form of `printValue` which can be formatted using `<<`
|
|
* without allocating an intermediate string.
|
|
* This class should not outlive the eval state or it will UAF.
|
|
* FIXME: This should take `nix::ref`s, to avoid that, but our eval methods all have
|
|
* EvalState &, not ref<EvalState>, and constructing a new shared_ptr to data that
|
|
* already has a shared_ptr is a much bigger footgun. In the current architecture of
|
|
* libexpr, using a ValuePrinter after an EvalState has been destroyed would be
|
|
* pretty hard.
|
|
*/
|
|
class ValuePrinter {
|
|
friend std::ostream & operator << (std::ostream & output, const ValuePrinter & printer);
|
|
private:
|
|
EvalState & state;
|
|
Value & value;
|
|
PrintOptions options;
|
|
|
|
public:
|
|
ValuePrinter(EvalState & state, Value & value, PrintOptions options = PrintOptions {})
|
|
: state(state), value(value), options(options) { }
|
|
};
|
|
|
|
std::ostream & operator<<(std::ostream & output, const ValuePrinter & printer);
|
|
|
|
|
|
/**
|
|
* `ValuePrinter` does its own ANSI formatting, so we don't color it
|
|
* magenta.
|
|
*/
|
|
template<>
|
|
fmt_internal::HintFmt & fmt_internal::HintFmt::operator%(const ValuePrinter & value);
|
|
|
|
}
|