Nix.Pretty

Documentation

data NixDoc

This type represents a pretty printed nix expression together with some information about the expression.

Constructors

NixDoc

Fields

• withoutParens :: Doc

  The rendered expression, without any parentheses.

• rootOp :: OperatorInfo

  The root operator is the operator at the root of the expression tree. For example, in '(a * b) + c', + would be the root operator. It is needed to determine if we need to wrap the expression in parentheses.

• wasPath :: Bool

mkNixDoc :: Doc -> OperatorInfo -> NixDoc

simpleExpr :: Doc -> NixDoc

A simple expression is never wrapped in parentheses. The expression behaves as if its root operator had a precedence higher than all other operators (including function application).

pathExpr :: Doc -> NixDoc

leastPrecedence :: Doc -> NixDoc

An expression that behaves as if its root operator had a precedence lower than all other operators. That ensures that the expression is wrapped in parantheses in almost always, but it's still rendered without parentheses in cases where parentheses are never required (such as in the LHS of a binding).

appOp :: OperatorInfo

appOpNonAssoc :: OperatorInfo

selectOp :: OperatorInfo

hasAttrOp :: OperatorInfo

wrapParens :: OperatorInfo -> NixDoc -> Doc

wrapPath :: OperatorInfo -> NixDoc -> Doc

prettyString :: NString NixDoc -> Doc

prettyParams :: Params NixDoc -> Doc

prettyParamSet :: ParamSet NixDoc -> Bool -> Doc

prettyBind :: Binding NixDoc -> Doc

prettyKeyName :: NKeyName NixDoc -> Doc

prettySelector :: NAttrPath NixDoc -> Doc

prettyAtom :: NAtom -> NixDoc

prettyNix :: NExpr -> Doc

prettyOriginExpr :: NExprLocF (Maybe (NValue m)) -> Doc

exprFNixDoc :: NExprF NixDoc -> NixDoc

prettyNValueNF :: Functor m => NValueNF m -> Doc

printNix :: Functor m => NValueNF m -> String

removeEffects :: Functor m => NValueF m (NThunk m) -> NValueNF m

removeEffectsM :: MonadVar m => NValueF m (NThunk m) -> m (NValueNF m)

prettyNValueF :: MonadVar m => NValueF m (NThunk m) -> m Doc

prettyNValue :: MonadVar m => NValue m -> m Doc

prettyNValueProv :: MonadVar m => NValue m -> m Doc

prettyNThunk :: MonadVar m => NThunk m -> m Doc

dethunk :: MonadVar m => NThunk m -> m (NValueNF m)